| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Wed May 15 06:53:05 UTC 2013 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="hadoop 1.2.0"
- jdversion="1.0.9">
- <!-- Command line arguments = -doclet jdiff.JDiff -docletpath /grid/0/dev/mfoley/hadoop-1.2/build/ivy/lib/Hadoop/jdiff/jdiff-1.0.9.jar:/grid/0/dev/mfoley/hadoop-1.2/build/ivy/lib/Hadoop/jdiff/xerces-1.4.4.jar -classpath /grid/0/dev/mfoley/hadoop-1.2/build/classes:/grid/0/dev/mfoley/hadoop-1.2/lib/hsqldb-1.8.0.10.jar:/grid/0/dev/mfoley/hadoop-1.2/lib/jsp-2.1/jsp-2.1.jar:/grid/0/dev/mfoley/hadoop-1.2/lib/jsp-2.1/jsp-api-2.1.jar:/grid/0/dev/mfoley/hadoop-1.2/lib/kfs-0.2.2.jar:/homes/hortonfo/.ivy2/cache/log4j/log4j/jars/log4j-1.2.15.jar:/homes/hortonfo/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.0.1.jar:/homes/hortonfo/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.4.jar:/homes/hortonfo/.ivy2/cache/commons-cli/commons-cli/jars/commons-cli-1.2.jar:/homes/hortonfo/.ivy2/cache/commons-io/commons-io/jars/commons-io-2.1.jar:/homes/hortonfo/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/homes/hortonfo/.ivy2/cache/commons-daemon/commons-daemon/jars/commons-daemon-1.0.1.jar:/homes/hortonfo/.ivy2/cache/net.java.dev.jets3t/jets3t/jars/jets3t-0.6.1.jar:/homes/hortonfo/.ivy2/cache/commons-net/commons-net/jars/commons-net-3.1.jar:/homes/hortonfo/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.26.jar:/homes/hortonfo/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.26.jar:/homes/hortonfo/.ivy2/cache/org.mortbay.jetty/servlet-api/jars/servlet-api-2.5-20081211.jar:/homes/hortonfo/.ivy2/cache/asm/asm/jars/asm-3.2.jar:/homes/hortonfo/.ivy2/cache/com.sun.jersey/jersey-core/bundles/jersey-core-1.8.jar:/homes/hortonfo/.ivy2/cache/com.sun.jersey/jersey-json/bundles/jersey-json-1.8.jar:/homes/hortonfo/.ivy2/cache/com.sun.jersey/jersey-server/bundles/jersey-server-1.8.jar:/homes/hortonfo/.ivy2/cache/tomcat/jasper-runtime/jars/jasper-runtime-5.5.12.jar:/homes/hortonfo/.ivy2/cache/tomcat/jasper-compiler/jars/jasper-compiler-5.5.12.jar:/homes/hortonfo/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/homes/hortonfo/.ivy2/cache/commons-configuration/commons-configuration/jars/commons-configuration-1.6.jar:/homes/hortonfo/.ivy2/cache/commons-collections/commons-collections/jars/commons-collections-3.2.1.jar:/homes/hortonfo/.ivy2/cache/commons-lang/commons-lang/jars/commons-lang-2.4.jar:/homes/hortonfo/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar:/homes/hortonfo/.ivy2/cache/commons-digester/commons-digester/jars/commons-digester-1.8.jar:/homes/hortonfo/.ivy2/cache/commons-beanutils/commons-beanutils/jars/commons-beanutils-1.7.0.jar:/homes/hortonfo/.ivy2/cache/commons-beanutils/commons-beanutils-core/jars/commons-beanutils-core-1.8.0.jar:/homes/hortonfo/.ivy2/cache/org.apache.commons/commons-math/jars/commons-math-2.1.jar:/homes/hortonfo/.ivy2/cache/junit/junit/jars/junit-4.5.jar:/homes/hortonfo/.ivy2/cache/commons-logging/commons-logging-api/jars/commons-logging-api-1.0.4.jar:/homes/hortonfo/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.4.3.jar:/homes/hortonfo/.ivy2/cache/org.eclipse.jdt/core/jars/core-3.1.1.jar:/homes/hortonfo/.ivy2/cache/oro/oro/jars/oro-2.0.8.jar:/homes/hortonfo/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.4.3.jar:/homes/hortonfo/.ivy2/cache/org.codehaus.jackson/jackson-mapper-asl/jars/jackson-mapper-asl-1.8.8.jar:/homes/hortonfo/.ivy2/cache/org.codehaus.jackson/jackson-core-asl/jars/jackson-core-asl-1.8.8.jar:/homes/hortonfo/.ivy2/cache/org.mockito/mockito-all/jars/mockito-all-1.8.5.jar:/homes/hortonfo/.ivy2/cache/com.jcraft/jsch/jars/jsch-0.1.42.jar:/homes/hortonfo/.ivy2/cache/org.aspectj/aspectjrt/jars/aspectjrt-1.6.11.jar:/homes/hortonfo/.ivy2/cache/org.aspectj/aspectjtools/jars/aspectjtools-1.6.11.jar:/homes/hortonfo/.ivy2/cache/org.vafer/jdeb/maven-plugins/jdeb-0.8.jar:/grid/0/dev/mfoley/hadoop-1.2/conf:/homes/hortonfo/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.0.4.jar:/homes/hortonfo/.ivy2/cache/jdiff/jdiff/jars/jdiff-1.0.9.jar:/homes/hortonfo/.ivy2/cache/xerces/xerces/jars/xerces-1.4.4.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-launcher.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-bcel.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-log4j.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-jsch.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-regexp.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-antlr.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-bsf.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-jdepend.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-jmf.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-testutil.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-netrexx.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-jai.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-oro.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-commons-logging.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-commons-net.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-javamail.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-swing.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-junit.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-junit4.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant.jar:/homes/hortonfo/tools/apache-ant-1.8.2/lib/ant-apache-resolver.jar:/homes/hortonfo/tools/jdk1.6.0_u31_64bit/lib/tools.jar -sourcepath /grid/0/dev/mfoley/hadoop-1.2/src/core:/grid/0/dev/mfoley/hadoop-1.2/src/mapred:/grid/0/dev/mfoley/hadoop-1.2/src/tools -apidir /grid/0/dev/mfoley/hadoop-1.2/lib/jdiff -apiname hadoop 1.2.0 -->
- <package name="org.apache.hadoop">
- <!-- start interface org.apache.hadoop.HadoopVersionAnnotation -->
- <interface name="HadoopVersionAnnotation" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <method name="version" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Hadoop version
- @return the version string "0.6.3-dev"]]>
- </doc>
- </method>
- <method name="user" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the username that compiled Hadoop.]]>
- </doc>
- </method>
- <method name="date" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the date when Hadoop was compiled.
- @return the date in unix 'date' format]]>
- </doc>
- </method>
- <method name="url" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the url for the subversion repository.]]>
- </doc>
- </method>
- <method name="revision" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the subversion revision.
- @return the revision number as a string (eg. "451451")]]>
- </doc>
- </method>
- <method name="srcChecksum" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a checksum of the source files from which
- Hadoop was compiled.
- @return a string that uniquely identifies the source]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A package attribute that captures the version of Hadoop that was compiled.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.HadoopVersionAnnotation -->
- </package>
- <package name="org.apache.hadoop.classification">
- <!-- start class org.apache.hadoop.classification.InterfaceAudience -->
- <class name="InterfaceAudience" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Annotation to inform users of a package, class or method's intended audience.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.classification.InterfaceAudience -->
- <!-- start interface org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate -->
- <interface name="InterfaceAudience.LimitedPrivate" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <method name="value" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Intended only for the project(s) specified in the annotation.
- For example, "Common", "HDFS", "MapReduce", "ZooKeeper", "HBase".]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate -->
- <!-- start interface org.apache.hadoop.classification.InterfaceAudience.Private -->
- <interface name="InterfaceAudience.Private" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Intended for use only within Hadoop itself.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceAudience.Private -->
- <!-- start interface org.apache.hadoop.classification.InterfaceAudience.Public -->
- <interface name="InterfaceAudience.Public" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Intended for use by any project or application.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceAudience.Public -->
- <!-- start class org.apache.hadoop.classification.InterfaceStability -->
- <class name="InterfaceStability" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InterfaceStability"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Annotation to inform users of how much to rely on a particular package,
- class or method not changing over time.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.classification.InterfaceStability -->
- <!-- start interface org.apache.hadoop.classification.InterfaceStability.Evolving -->
- <interface name="InterfaceStability.Evolving" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Evolving, but can break compatibility at minor release (i.e. m.x)]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceStability.Evolving -->
- <!-- start interface org.apache.hadoop.classification.InterfaceStability.Stable -->
- <interface name="InterfaceStability.Stable" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[Can evolve while retaining compatibility for minor release boundaries.;
- can break compatibility only at major release (ie. at m.0).]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceStability.Stable -->
- <!-- start interface org.apache.hadoop.classification.InterfaceStability.Unstable -->
- <interface name="InterfaceStability.Unstable" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[No guarantee is provided as to reliability or stability across any
- level of release granularity.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.classification.InterfaceStability.Unstable -->
- </package>
- <package name="org.apache.hadoop.conf">
- <!-- start interface org.apache.hadoop.conf.Configurable -->
- <interface name="Configurable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration to be used by this object.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the configuration used by this object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Something that may be configured with a {@link Configuration}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.conf.Configurable -->
- <!-- start class org.apache.hadoop.conf.Configuration -->
- <class name="Configuration" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Iterable"/>
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration.]]>
- </doc>
- </constructor>
- <constructor name="Configuration" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration where the behavior of reading from the default
- resources can be turned off.
-
- If the parameter {@code loadDefaults} is false, the new instance
- will not load resources from the default files.
- @param loadDefaults specifies whether to load from the default files]]>
- </doc>
- </constructor>
- <constructor name="Configuration" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new configuration with the same settings cloned from another.
-
- @param other the configuration from which to clone settings.]]>
- </doc>
- </constructor>
- <method name="addDefaultResource"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a default resource. Resources are loaded in the order of the resources
- added.
- @param name file name. File should be present in the classpath.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param name resource to be added, the classpath is examined for a file
- with that name.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param url url of the resource to be added, the local filesystem is
- examined directly to find the resource, without referring to
- the classpath.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param file file-path of resource to be added, the local filesystem is
- examined directly to find the resource, without referring to
- the classpath.]]>
- </doc>
- </method>
- <method name="addResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <doc>
- <![CDATA[Add a configuration resource.
-
- The properties of this resource will override properties of previously
- added resources, unless they were marked <a href="#Final">final</a>.
-
- @param in InputStream to deserialize the object from.]]>
- </doc>
- </method>
- <method name="reloadConfiguration"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reload configuration from previously added resources.
- This method will clear all the configuration read from the added
- resources, and final parameters. This will make the resources to
- be read again before accessing the values. Values that are added
- via set methods will overlay values read from the resources.]]>
- </doc>
- </method>
- <method name="get" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property, <code>null</code> if
- no such property exists.
-
- Values are processed for <a href="#VariableExpansion">variable expansion</a>
- before being returned.
-
- @param name the property name.
- @return the value of the <code>name</code> property,
- or null if no such property exists.]]>
- </doc>
- </method>
- <method name="getRaw" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property, without doing
- <a href="#VariableExpansion">variable expansion</a>.
-
- @param name the property name.
- @return the value of the <code>name</code> property,
- or null if no such property exists.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>value</code> of the <code>name</code> property.
-
- @param name property name.
- @param value property value.]]>
- </doc>
- </method>
- <method name="unset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Unset a previously set property.]]>
- </doc>
- </method>
- <method name="setIfUnset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets a property if it is currently unset.
- @param name the property name
- @param value the new value]]>
- </doc>
- </method>
- <method name="get" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property. If no such property
- exists, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value, or <code>defaultValue</code> if the property
- doesn't exist.]]>
- </doc>
- </method>
- <method name="getInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="int"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as an <code>int</code>.
-
- If no such property exists, or if the specified value is not a valid
- <code>int</code>, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value as an <code>int</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to an <code>int</code>.
-
- @param name property name.
- @param value <code>int</code> value of the property.]]>
- </doc>
- </method>
- <method name="getLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="long"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>long</code>.
- If no such property is specified, or if the specified value is not a valid
- <code>long</code>, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value as a <code>long</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>long</code>.
-
- @param name property name.
- @param value <code>long</code> value of the property.]]>
- </doc>
- </method>
- <method name="getFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="float"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>float</code>.
- If no such property is specified, or if the specified value is not a valid
- <code>float</code>, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value as a <code>float</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>float</code>.
-
- @param name property name.
- @param value property value.]]>
- </doc>
- </method>
- <method name="getBoolean" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="boolean"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>boolean</code>.
- If no such property is specified, or if the specified value is not a valid
- <code>boolean</code>, then <code>defaultValue</code> is returned.
-
- @param name property name.
- @param defaultValue default value.
- @return property value as a <code>boolean</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="setBoolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to a <code>boolean</code>.
-
- @param name property name.
- @param value <code>boolean</code> value of the property.]]>
- </doc>
- </method>
- <method name="setBooleanIfUnset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the given property, if it is currently unset.
- @param name property name
- @param value new value]]>
- </doc>
- </method>
- <method name="setEnum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to the given type. This
- is equivalent to <code>set(<name>, value.toString())</code>.
- @param name property name
- @param value new value]]>
- </doc>
- </method>
- <method name="getEnum" return="java.lang.Enum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Return value matching this enumerated type.
- @param name Property name
- @param defaultValue Value returned if no mapping exists
- @throws IllegalArgumentException If mapping is illegal for the type
- provided]]>
- </doc>
- </method>
- <method name="getRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Parse the given attribute as a set of integer ranges
- @param name the attribute name
- @param defaultValue the default value if it is not set
- @return a new set of ranges from the configured value]]>
- </doc>
- </method>
- <method name="getStringCollection" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- a collection of <code>String</code>s.
- If no such property is specified then empty collection is returned.
- <p>
- This is an optimized version of {@link #getStrings(String)}
-
- @param name property name.
- @return property value as a collection of <code>String</code>s.]]>
- </doc>
- </method>
- <method name="getStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s.
- If no such property is specified then <code>null</code> is returned.
-
- @param name property name.
- @return property value as an array of <code>String</code>s,
- or <code>null</code>.]]>
- </doc>
- </method>
- <method name="getStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Get the comma delimited values of the <code>name</code> property as
- an array of <code>String</code>s.
- If no such property is specified then default value is returned.
-
- @param name property name.
- @param defaultValue The default value
- @return property value as an array of <code>String</code>s,
- or default value.]]>
- </doc>
- </method>
- <method name="setStrings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="values" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Set the array of string values for the <code>name</code> property as
- as comma delimited values.
-
- @param name property name.
- @param values The values]]>
- </doc>
- </method>
- <method name="getClassByName" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Load a class by name.
-
- @param name the class name.
- @return the class object.
- @throws ClassNotFoundException if the class is not found.]]>
- </doc>
- </method>
- <method name="getClasses" return="java.lang.Class[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class[]"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property
- as an array of <code>Class</code>.
- The value of the property specifies a list of comma separated class names.
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- @param name the property name.
- @param defaultValue default value.
- @return property value as a <code>Class[]</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>.
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- @param name the class name.
- @param defaultValue default value.
- @return property value as a <code>Class</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>
- implementing the interface specified by <code>xface</code>.
-
- If no such property is specified, then <code>defaultValue</code> is
- returned.
-
- An exception is thrown if the returned class does not implement the named
- interface.
-
- @param name the class name.
- @param defaultValue default value.
- @param xface the interface implemented by the named class.
- @return property value as a <code>Class</code>,
- or <code>defaultValue</code>.]]>
- </doc>
- </method>
- <method name="getInstances" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the value of the <code>name</code> property as a <code>List</code>
- of objects implementing the interface specified by <code>xface</code>.
-
- An exception is thrown if any of the classes does not exist, or if it does
- not implement the named interface.
-
- @param name the property name.
- @param xface the interface implemented by the classes named by
- <code>name</code>.
- @return a <code>List</code> of objects implementing <code>xface</code>.]]>
- </doc>
- </method>
- <method name="setClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="theClass" type="java.lang.Class"/>
- <param name="xface" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value of the <code>name</code> property to the name of a
- <code>theClass</code> implementing the given interface <code>xface</code>.
-
- An exception is thrown if <code>theClass</code> does not implement the
- interface <code>xface</code>.
-
- @param name property name.
- @param theClass property value.
- @param xface the interface implemented by the named class.]]>
- </doc>
- </method>
- <method name="getLocalPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dirsProp" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a local file under a directory named by <i>dirsProp</i> with
- the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
- then one is chosen based on <i>path</i>'s hash code. If the selected
- directory does not exist, an attempt is made to create it.
-
- @param dirsProp directory in which to locate the file.
- @param path file-path.
- @return local file under the directory with the given path.]]>
- </doc>
- </method>
- <method name="getFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dirsProp" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a local file name under a directory named in <i>dirsProp</i> with
- the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
- then one is chosen based on <i>path</i>'s hash code. If the selected
- directory does not exist, an attempt is made to create it.
-
- @param dirsProp directory in which to locate the file.
- @param path file-path.
- @return local file under the directory with the given path.]]>
- </doc>
- </method>
- <method name="getResource" return="java.net.URL"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the {@link URL} for the named resource.
-
- @param name resource name.
- @return the url for the named resource.]]>
- </doc>
- </method>
- <method name="getConfResourceAsInputStream" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get an input stream attached to the configuration resource with the
- given <code>name</code>.
-
- @param name configuration resource name.
- @return an input stream attached to the resource.]]>
- </doc>
- </method>
- <method name="getConfResourceAsReader" return="java.io.Reader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a {@link Reader} attached to the configuration resource with the
- given <code>name</code>.
-
- @param name configuration resource name.
- @return a reader attached to the resource.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of keys in the configuration.
- @return number of keys in the configuration.]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clears all keys from the configuration.]]>
- </doc>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get an {@link Iterator} to go through the list of <code>String</code>
- key-value pairs in the configuration.
-
- @return an iterator over the entries.]]>
- </doc>
- </method>
- <method name="writeXml"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write out the non-default properties in this configuration to the given
- {@link OutputStream}.
-
- @param out the output stream to write to.]]>
- </doc>
- </method>
- <method name="writeXml"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write out the non-default properties in this configuration to the given
- {@link Writer}.
-
- @param out the writer to write to.]]>
- </doc>
- </method>
- <method name="dumpConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="java.io.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes out all the parameters and their properties (final and resource) to
- the given {@link Writer}
- The format of the output would be
- { "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2,
- key2.isFinal,key2.resource}... ] }
- It does not output the parameters of the configuration object which is
- loaded from an input stream.
- @param out the Writer to write to
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClassLoader" return="java.lang.ClassLoader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ClassLoader} for this job.
-
- @return the correct class loader.]]>
- </doc>
- </method>
- <method name="setClassLoader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="classLoader" type="java.lang.ClassLoader"/>
- <doc>
- <![CDATA[Set the class loader that will be used to load the various objects.
-
- @param classLoader the new class loader.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setQuietMode"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="quietmode" type="boolean"/>
- <doc>
- <![CDATA[Set the quietness-mode.
-
- In the quiet-mode, error and informational messages might not be logged.
-
- @param quietmode <code>true</code> to set quiet-mode on, <code>false</code>
- to turn it off.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[For debugging. List non-default properties to the terminal and exit.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getValByRegex" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="regex" type="java.lang.String"/>
- <doc>
- <![CDATA[get keys matching the the regex
- @param regex
- @return Map<String,String> with matching keys]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provides access to configuration parameters.
- <h4 id="Resources">Resources</h4>
- <p>Configurations are specified by resources. A resource contains a set of
- name/value pairs as XML data. Each resource is named by either a
- <code>String</code> or by a {@link Path}. If named by a <code>String</code>,
- then the classpath is examined for a file with that name. If named by a
- <code>Path</code>, then the local filesystem is examined directly, without
- referring to the classpath.
- <p>Unless explicitly turned off, Hadoop by default specifies two
- resources, loaded in-order from the classpath: <ol>
- <li><tt><a href="{@docRoot}/../core-default.html">core-default.xml</a>
- </tt>: Read-only defaults for hadoop.</li>
- <li><tt>core-site.xml</tt>: Site-specific configuration for a given hadoop
- installation.</li>
- </ol>
- Applications may add additional resources, which are loaded
- subsequent to these resources in the order they are added.
-
- <h4 id="FinalParams">Final Parameters</h4>
- <p>Configuration parameters may be declared <i>final</i>.
- Once a resource declares a value final, no subsequently-loaded
- resource can alter that value.
- For example, one might define a final parameter with:
- <tt><pre>
- <property>
- <name>dfs.client.buffer.dir</name>
- <value>/tmp/hadoop/dfs/client</value>
- <b><final>true</final></b>
- </property></pre></tt>
- Administrators typically define parameters as final in
- <tt>core-site.xml</tt> for values that user applications may not alter.
- <h4 id="VariableExpansion">Variable Expansion</h4>
- <p>Value strings are first processed for <i>variable expansion</i>. The
- available properties are:<ol>
- <li>Other properties defined in this Configuration; and, if a name is
- undefined here,</li>
- <li>Properties in {@link System#getProperties()}.</li>
- </ol>
- <p>For example, if a configuration resource contains the following property
- definitions:
- <tt><pre>
- <property>
- <name>basedir</name>
- <value>/user/${<i>user.name</i>}</value>
- </property>
-
- <property>
- <name>tempdir</name>
- <value>${<i>basedir</i>}/tmp</value>
- </property></pre></tt>
- When <tt>conf.get("tempdir")</tt> is called, then <tt>${<i>basedir</i>}</tt>
- will be resolved to another property in this Configuration, while
- <tt>${<i>user.name</i>}</tt> would then ordinarily be resolved to the value
- of the System property with that name.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.Configuration -->
- <!-- start class org.apache.hadoop.conf.Configuration.IntegerRanges -->
- <class name="Configuration.IntegerRanges" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Configuration.IntegerRanges"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Configuration.IntegerRanges" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isIncluded" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Is the given value in the set of ranges
- @param value the value to check
- @return is the value in the ranges?]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A class that represents a set of positive integer ranges. It parses
- strings of the form: "2-3,5,7-" where ranges are separated by comma and
- the lower/upper bounds are separated by dash. Either the lower or upper
- bound may be omitted meaning all values up to or over. So the string
- above means 2, 3, 5, and 7, 8, 9, ...]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.Configuration.IntegerRanges -->
- <!-- start class org.apache.hadoop.conf.Configured -->
- <class name="Configured" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="Configured"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Configured.]]>
- </doc>
- </constructor>
- <constructor name="Configured" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Configured.]]>
- </doc>
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Base class for things that may be configured with a {@link Configuration}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.Configured -->
- <!-- start class org.apache.hadoop.conf.ConfServlet -->
- <class name="ConfServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ConfServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A servlet to print out the running configuration data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.conf.ConfServlet -->
- <!-- start class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
- <class name="ConfServlet.BadFormatException" extends="java.lang.Exception"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ConfServlet.BadFormatException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
- </package>
- <package name="org.apache.hadoop.fs">
- <!-- start class org.apache.hadoop.fs.BlockLocation -->
- <class name="BlockLocation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="BlockLocation"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default Constructor]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, offset and length]]>
- </doc>
- </constructor>
- <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with host, name, network topology, offset and length]]>
- </doc>
- </constructor>
- <method name="getHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of hosts (hostname) hosting this block]]>
- </doc>
- </method>
- <method name="getNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of names (hostname:port) hosting this block]]>
- </doc>
- </method>
- <method name="getTopologyPaths" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of network topology paths for each of the hosts.
- The last component of the path is the host.]]>
- </doc>
- </method>
- <method name="getOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start offset of file associated with this block]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the length of the block]]>
- </doc>
- </method>
- <method name="setOffset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="offset" type="long"/>
- <doc>
- <![CDATA[Set the start offset of file associated with this block]]>
- </doc>
- </method>
- <method name="setLength"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="length" type="long"/>
- <doc>
- <![CDATA[Set the length of block]]>
- </doc>
- </method>
- <method name="setHosts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hosts" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the hosts hosting this block]]>
- </doc>
- </method>
- <method name="setNames"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the names (host:port) hosting this block]]>
- </doc>
- </method>
- <method name="setTopologyPaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="topologyPaths" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the network topology paths of the hosts]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implement write of Writable]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implement readFields of Writable]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.fs.BlockLocation -->
- <!-- start class org.apache.hadoop.fs.BufferedFSInputStream -->
- <class name="BufferedFSInputStream" extends="java.io.BufferedInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <implements name="org.apache.hadoop.fs.PositionedReadable"/>
- <implements name="org.apache.hadoop.fs.HasFileDescriptor"/>
- <constructor name="BufferedFSInputStream" type="org.apache.hadoop.fs.FSInputStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a <code>BufferedFSInputStream</code>
- with the specified buffer size,
- and saves its argument, the input stream
- <code>in</code>, for later use. An internal
- buffer array of length <code>size</code>
- is created and stored in <code>buf</code>.
- @param in the underlying input stream.
- @param size the buffer size.
- @exception IllegalArgumentException if size <= 0.]]>
- </doc>
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileDescriptor" return="java.io.FileDescriptor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A class optimizes reading from FSInputStream by bufferring]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.BufferedFSInputStream -->
- <!-- start class org.apache.hadoop.fs.ChecksumException -->
- <class name="ChecksumException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChecksumException" type="java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Thrown for checksum errors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ChecksumException -->
- <!-- start class org.apache.hadoop.fs.ChecksumFileSystem -->
- <class name="ChecksumFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChecksumFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApproxChkSumLength" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <doc>
- <![CDATA[Set whether to verify checksum.]]>
- </doc>
- </method>
- <method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the raw file system]]>
- </doc>
- </method>
- <method name="getChecksumFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return the name of the checksum file associated with a file.]]>
- </doc>
- </method>
- <method name="isChecksumFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return true iff file is a checksum file name.]]>
- </doc>
- </method>
- <method name="getChecksumFileLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="fileSize" type="long"/>
- <doc>
- <![CDATA[Return the length of the checksum file given the size of the
- actual file.]]>
- </doc>
- </method>
- <method name="getBytesPerSum" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the bytes Per Checksum]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getChecksumLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- <param name="bytesPerSum" type="int"/>
- <doc>
- <![CDATA[Calculated the length of the checksum file in bytes.
- @param size the length of the data file in bytes
- @param bytesPerSum the number of bytes in a checksum block
- @return the number of bytes in the checksum file]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
- Implement the abstract <tt>setReplication</tt> of <tt>FileSystem</tt>
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful;
- false if file does not exist or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rename files/dirs]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implement the delete(Path, boolean) in checksum
- file system.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
-
- @param f
- given path
- @return the statuses of the files/directories in the given patch
- @throws IOException]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="copyCrc" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- If src and dst are directories, the copyCrc parameter
- determines whether to copy CRC files.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reportChecksumFailure" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="inPos" type="long"/>
- <param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="sumsPos" type="long"/>
- <doc>
- <![CDATA[Report a checksum error to the file system.
- @param f the file name containing the error
- @param in the stream open on the file
- @param inPos the position of the beginning of the bad data in the file
- @param sums the stream open on the checksum file
- @param sumsPos the position of the beginning of the bad data in the checksum file
- @return if retry is neccessary]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Abstract Checksumed FileSystem.
- It provide a basice implementation of a Checksumed FileSystem,
- which creates a checksum file for each raw file.
- It generates & verifies checksums at the client side.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ChecksumFileSystem -->
- <!-- start class org.apache.hadoop.fs.CommonConfigurationKeys -->
- <class name="CommonConfigurationKeys" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CommonConfigurationKeys"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="FS_DEFAULT_NAME_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_GROUP_MAPPING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_AUTHENTICATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_AUTHORIZATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_SERVICE_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_TOKEN_SERVICE_USE_IP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SECURITY_TOKEN_SERVICE_USE_IP_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_USE_WEAK_HTTP_CRYPTO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SECURITY_USE_WEAK_HTTP_CRYPTO_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_SERVER_RPC_READ_THREADS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_SERVER_RPC_READ_THREADS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IO_NATIVE_LIB_AVAILABLE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IO_NATIVE_LIB_AVAILABLE_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_NATIVE_LIB_AVAILABLE_KEY]]>
- </doc>
- </field>
- <field name="IO_COMPRESSION_CODEC_SNAPPY_BUFFERSIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Internal buffer size for Snappy compressor/decompressors]]>
- </doc>
- </field>
- <field name="IO_COMPRESSION_CODEC_SNAPPY_BUFFERSIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for IO_COMPRESSION_CODEC_SNAPPY_BUFFERSIZE_KEY]]>
- </doc>
- </field>
- <field name="HADOOP_RELAXED_VERSION_CHECK_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_RELAXED_VERSION_CHECK_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_SKIP_VERSION_CHECK_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[See src/core/core-default.xml]]>
- </doc>
- </field>
- <field name="HADOOP_SKIP_VERSION_CHECK_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_JETTY_LOGS_SERVE_ALIASES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/Disable aliases serving from jetty]]>
- </doc>
- </field>
- <field name="DEFAULT_HADOOP_JETTY_LOGS_SERVE_ALIASES" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class contains constants for configuration keys used
- in the common code.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.CommonConfigurationKeys -->
- <!-- start class org.apache.hadoop.fs.ContentSummary -->
- <class name="ContentSummary" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ContentSummary"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor]]>
- </doc>
- </constructor>
- <constructor name="ContentSummary" type="long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor]]>
- </doc>
- </constructor>
- <constructor name="ContentSummary" type="long, long, long, long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor]]>
- </doc>
- </constructor>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the length]]>
- </doc>
- </method>
- <method name="getDirectoryCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the directory count]]>
- </doc>
- </method>
- <method name="getFileCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the file count]]>
- </doc>
- </method>
- <method name="getQuota" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the directory quota]]>
- </doc>
- </method>
- <method name="getSpaceConsumed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retuns (disk) space consumed]]>
- </doc>
- </method>
- <method name="getSpaceQuota" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns (disk) space quota]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getHeader" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <doc>
- <![CDATA[Return the header of the output.
- if qOption is false, output directory count, file count, and content size;
- if qOption is true, output quota and remaining quota as well.
-
- @param qOption a flag indicating if quota needs to be printed or not
- @return the header of the output]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qOption" type="boolean"/>
- <doc>
- <![CDATA[Return the string representation of the object in the output format.
- if qOption is false, output directory count, file count, and content size;
- if qOption is true, output quota and remaining quota as well.
-
- @param qOption a flag indicating if quota needs to be printed or not
- @return the string representation of the object]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Store the summary of a content (a directory or a file).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ContentSummary -->
- <!-- start class org.apache.hadoop.fs.DF -->
- <class name="DF" extends="org.apache.hadoop.util.Shell"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DF" type="java.io.File, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="DF" type="java.io.File, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getDirPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the canonical path to the volume we're checking.]]>
- </doc>
- </method>
- <method name="getFilesystem" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return a string indicating which filesystem volume we're checking.]]>
- </doc>
- </method>
- <method name="getCapacity" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the capacity of the measured filesystem in bytes.]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the total used space on the filesystem in bytes.]]>
- </doc>
- </method>
- <method name="getAvailable" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the usable space remaining on the filesystem in bytes.]]>
- </doc>
- </method>
- <method name="getPercentUsed" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the amount of the volume full, as a percent.]]>
- </doc>
- </method>
- <method name="getMount" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return the filesystem mount point for the indicated volume]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getExecString" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="parseExecResult"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="lines" type="java.io.BufferedReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="DF_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default DF refresh interval.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Filesystem disk space usage statistics. Uses the unix 'df' program to get
- mount points, and java.io.File for space utilization. Tested on Linux,
- FreeBSD, Cygwin.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.DF -->
- <!-- start class org.apache.hadoop.fs.DU -->
- <class name="DU" extends="org.apache.hadoop.util.Shell"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DU" type="java.io.File, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keeps track of disk usage.
- @param path the path to check disk usage in
- @param interval refresh the disk usage at this interval
- @throws IOException if we fail to refresh the disk usage]]>
- </doc>
- </constructor>
- <constructor name="DU" type="java.io.File, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Keeps track of disk usage.
- @param path the path to check disk usage in
- @param conf configuration object
- @throws IOException if we fail to refresh the disk usage]]>
- </doc>
- </constructor>
- <method name="decDfsUsed"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Decrease how much disk space we use.
- @param value decrease by this value]]>
- </doc>
- </method>
- <method name="incDfsUsed"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Increase how much disk space we use.
- @param value increase by this value]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return disk space used
- @throws IOException if the shell command fails]]>
- </doc>
- </method>
- <method name="getDirPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the path of which we're keeping track of disk usage]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start the disk usage checking thread.]]>
- </doc>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Shut down the refreshing thread.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getExecString" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="parseExecResult"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="lines" type="java.io.BufferedReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[Filesystem disk space usage statistics. Uses the unix 'du' program]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.DU -->
- <!-- start class org.apache.hadoop.fs.FileAlreadyExistsException -->
- <class name="FileAlreadyExistsException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileAlreadyExistsException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileAlreadyExistsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Used when target file already exists for any operation and
- is not configured to be overwritten.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileAlreadyExistsException -->
- <!-- start class org.apache.hadoop.fs.FileChecksum -->
- <class name="FileChecksum" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FileChecksum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAlgorithmName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The checksum algorithm name]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The length of the checksum in bytes]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The value of the checksum in bytes]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return true if both the algorithms and the values are the same.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An abstract class representing file checksums for files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileChecksum -->
- <!-- start class org.apache.hadoop.fs.FileStatus -->
- <class name="FileStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Comparable"/>
- <constructor name="FileStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileStatus" type="long, boolean, int, long, long, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLen" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isDir" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this a directory?
- @return true if this is a directory]]>
- </doc>
- </method>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the block size of the file.
- @return the number of bytes]]>
- </doc>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the replication factor of a file.
- @return the replication factor of a file.]]>
- </doc>
- </method>
- <method name="getModificationTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the modification time of the file.
- @return the modification time of file in milliseconds since January 1, 1970 UTC.]]>
- </doc>
- </method>
- <method name="getAccessTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the access time of the file.
- @return the access time of file in milliseconds since January 1, 1970 UTC.]]>
- </doc>
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get FsPermission associated with the file.
- @return permssion. If a filesystem does not have a notion of permissions
- or if permissions could not be determined, then default
- permissions equivalent of "rwxrwxrwx" is returned.]]>
- </doc>
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the owner of the file.
- @return owner of the file. The string could be empty if there is no
- notion of owner of a file in a filesystem or if it could not
- be determined (rare).]]>
- </doc>
- </method>
- <method name="getGroup" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the group associated with the file.
- @return group for the file. The string could be empty if there is no
- notion of group of a file in a filesystem or if it could not
- be determined (rare).]]>
- </doc>
- </method>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Sets permission.
- @param permission if permission is null, default value is set]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="owner" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets owner.
- @param owner if it is null, default value is set]]>
- </doc>
- </method>
- <method name="setGroup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets group.
- @param group if it is null, default value is set]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare this object to another object
-
- @param o the object to be compared.
- @return a negative integer, zero, or a positive integer as this object
- is less than, equal to, or greater than the specified object.
-
- @throws ClassCastException if the specified object's is not of
- type FileStatus]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare if this object is equal to another object
- @param o the object to be compared.
- @return true if two file status has the same path name; false if not.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a hash code value for the object, which is defined as
- the hash code of the path name.
- @return a hash code value for the path name.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface that represents the client side information for a file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileStatus -->
- <!-- start class org.apache.hadoop.fs.FileSystem -->
- <class name="FileSystem" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="FileSystem"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="addFileSystemForTesting"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method adds a file system for testing so that we can find it later.
- It is only for testing.
- @param uri the uri to store it under
- @param conf the configuration to store it under
- @param fs the file system to store
- @throws IOException]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the configured filesystem implementation.]]>
- </doc>
- </method>
- <method name="getDefaultUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the default filesystem URI from a configuration.
- @param conf the configuration to access
- @return the uri of the default filesystem]]>
- </doc>
- </method>
- <method name="setDefaultUri"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="uri" type="java.net.URI"/>
- <doc>
- <![CDATA[Set the default filesystem URI in a configuration.
- @param conf the configuration to alter
- @param uri the new default filesystem uri]]>
- </doc>
- </method>
- <method name="setDefaultUri"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="uri" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the default filesystem URI in a configuration.
- @param conf the configuration to alter
- @param uri the new default filesystem uri]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called after a new FileSystem instance is constructed.
- @param name a uri whose authority section names the host, port, etc.
- for this FileSystem
- @param conf the configuration]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]>
- </doc>
- </method>
- <method name="getCanonicalUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resolve the uri's hostname and add the default port if not in the uri
- @return URI
- @see NetUtils#getCanonicalUri(URI, int)]]>
- </doc>
- </method>
- <method name="getDefaultPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default port for this file system.
- @return the default port or 0 if there isn't one]]>
- </doc>
- </method>
- <method name="getCanonicalServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a canonical service name for this file system. The token cache is
- the only user of this value, and uses it to lookup this filesystem's
- service tokens. The token cache will not attempt to acquire tokens if the
- service is null.
- @return a service string that uniquely identifies this file system, null
- if the filesystem does not implement tokens
- @see SecurityUtil#buildDTServiceName(URI, int)]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="call #getUri() instead.">
- <doc>
- <![CDATA[@deprecated call #getUri() instead.]]>
- </doc>
- </method>
- <method name="getNamed" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="call #get(URI,Configuration) instead.">
- <param name="name" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated call #get(URI,Configuration) instead.]]>
- </doc>
- </method>
- <method name="getLocal" return="org.apache.hadoop.fs.LocalFileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the local file syste
- @param conf the configuration to configure the file system with
- @return a LocalFileSystem]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the FileSystem for this URI's scheme and authority. The scheme
- of the URI determines a configuration property name,
- <tt>fs.<i>scheme</i>.class</tt> whose value names the FileSystem class.
- The entire URI is passed to the FileSystem instance's initialize method.]]>
- </doc>
- </method>
- <method name="closeAll"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close all cached filesystems. Be sure those filesystems are not
- used anymore.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="closeAllForUGI"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close all cached filesystems for a given UGI. Be sure those filesystems
- are not used anymore.
- @param ugi
- @throws IOException]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Make sure that a path specifies a FileSystem.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[create a file with the provided permission
- The permission of the file is set to be the provided permission as in
- setPermission, not permission&~umask
-
- It is implemented using two RPCs. It is understood that it is inefficient,
- but the implementation is thread-safe. The other option is to change the
- value of umask in configuration to be 0, but it is not thread-safe.
-
- @param fs file system handle
- @param file the name of the file to be created
- @param permission the permission of the file
- @return an output stream
- @throws IOException]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[create a directory with the provided permission
- The permission of the directory is set to be the provided permission as in
- setPermission, not permission&~umask
-
- @see #create(FileSystem, Path, FsPermission)
-
- @param fs file system handle
- @param dir the name of the directory to be created
- @param permission the permission of the directory
- @return true if the directory creation succeeds; false otherwise
- @throws IOException]]>
- </doc>
- </method>
- <method name="checkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Check that a Path belongs to this FileSystem.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array containing hostnames, offset and size of
- portions of the given file. For a nonexistent
- file or regions, null will be returned.
- This call is most helpful with DFS, where it returns
- hostnames of machines that contain the given file.
- The FileSystem will simply return an elt containing 'localhost'.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file to open]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path.
- Files are overwritten by default.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- Files are overwritten by default.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path.
- Files are overwritten by default.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- Files are overwritten by default.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting.
- @param f the file name to open
- @param permission
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize
- @param progress
- @throws IOException
- @see #setPermission(Path, FsPermission)]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="API only for 0.20-append">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting. Same as create(), except fails if parent directory doesn't
- already exist.
- @param f the file name to open
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize
- @param progress
- @throws IOException
- @see #setPermission(Path, FsPermission)
- @deprecated API only for 0.20-append]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="API only for 0.20-append">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress
- reporting. Same as create(), except fails if parent directory doesn't
- already exist.
- @param f the file name to open
- @param permission
- @param overwrite if a file with this name already exists, then if true,
- the file will be overwritten, and if false an error will be thrown.
- @param bufferSize the size of the buffer to be used.
- @param replication required block replication for the file.
- @param blockSize
- @param progress
- @throws IOException
- @see #setPermission(Path, FsPermission)
- @deprecated API only for 0.20-append]]>
- </doc>
- </method>
- <method name="createNewFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates the given Path as a brand-new zero-length file. If
- create fails, or if it already existed, return false.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- Same as append(f, getConf().getInt("io.file.buffer.size", 4096), null)
- @param f the existing file to be appended.
- @throws IOException]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- Same as append(f, bufferSize, null).
- @param f the existing file to be appended.
- @param bufferSize the size of the buffer to be used.
- @throws IOException]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append to an existing file (optional operation).
- @param f the existing file to be appended.
- @param bufferSize the size of the buffer to be used.
- @param progress for reporting progress if it is not null.
- @throws IOException]]>
- </doc>
- </method>
- <method name="concat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trg" type="org.apache.hadoop.fs.Path"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Concat existing files together.
- @param trg the path to the target destination.
- @param psrcs the paths to the sources to use for the concatenation.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use getFileStatus() instead">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get replication.
-
- @deprecated Use getFileStatus() instead
- @param src file name
- @return file replication
- @throws IOException]]>
- </doc>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
-
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful;
- false if file does not exist or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst. Can take place on local fs
- or remote DFS.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use delete(Path, boolean) instead">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use delete(Path, boolean) instead]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file.
- @param f the path to delete.
- @param recursive if path is a directory and set to
- true, the directory is deleted else throws an exception. In
- case of a file the recursive can be set to either true or false.
- @return true if delete is successful else false.
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteOnExit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark a path to be deleted when FileSystem is closed.
- When the JVM shuts down,
- all FileSystem objects will be closed automatically.
- Then,
- the marked path will be deleted as a result of closing the FileSystem.
- The path has to exist in the file system.
-
- @param f the path to delete.
- @return true if deleteOnExit is successful, otherwise false.
- @throws IOException]]>
- </doc>
- </method>
- <method name="processDeleteOnExit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delete all files that were marked as delete-on-exit. This recursively
- deletes all files in the specified paths.]]>
- </doc>
- </method>
- <method name="exists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if exists.
- @param f source file]]>
- </doc>
- </method>
- <method name="isDirectory" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use getFileStatus() instead">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use getFileStatus() instead]]>
- </doc>
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[True iff the named path is a regular file.]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use getFileStatus() instead">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use getFileStatus() instead]]>
- </doc>
- </method>
- <method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the {@link ContentSummary} of a given {@link Path}.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List the statuses of the files/directories in the given path if the path is
- a directory.
-
- @param f
- given path
- @return the statuses of the files/directories in the given patch
- returns null, if Path f does not exist in the FileSystem
- @throws IOException]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given path using the user-supplied path
- filter.
-
- @param f
- a path name
- @param filter
- the user-supplied path filter
- @return an array of FileStatus objects for the files under the given path
- after applying the filter
- @throws IOException
- if encounter any problem while fetching the status]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="files" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given list of paths using default
- path filter.
-
- @param files
- a list of paths
- @return a list of statuses for the files under the given paths after
- applying the filter default Path filter
- @exception IOException]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="files" type="org.apache.hadoop.fs.Path[]"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Filter files/directories in the given list of paths using user-supplied
- path filter.
-
- @param files
- a list of paths
- @param filter
- the user-supplied path filter
- @return a list of statuses for the files under the given paths after
- applying the filter
- @exception IOException]]>
- </doc>
- </method>
- <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Return all the files that match filePattern and are not checksum
- files. Results are sorted by their names.
-
- <p>
- A filename pattern is composed of <i>regular</i> characters and
- <i>special pattern matching</i> characters, which are:
- <dl>
- <dd>
- <dl>
- <p>
- <dt> <tt> ? </tt>
- <dd> Matches any single character.
- <p>
- <dt> <tt> * </tt>
- <dd> Matches zero or more characters.
- <p>
- <dt> <tt> [<i>abc</i>] </tt>
- <dd> Matches a single character from character set
- <tt>{<i>a,b,c</i>}</tt>.
- <p>
- <dt> <tt> [<i>a</i>-<i>b</i>] </tt>
- <dd> Matches a single character from the character range
- <tt>{<i>a...b</i>}</tt>. Note that character <tt><i>a</i></tt> must be
- lexicographically less than or equal to character <tt><i>b</i></tt>.
- <p>
- <dt> <tt> [^<i>a</i>] </tt>
- <dd> Matches a single character that is not from character set or range
- <tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur
- immediately to the right of the opening bracket.
- <p>
- <dt> <tt> \<i>c</i> </tt>
- <dd> Removes (escapes) any special meaning of character <i>c</i>.
- <p>
- <dt> <tt> {ab,cd} </tt>
- <dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt>
-
- <p>
- <dt> <tt> {ab,c{de,fh}} </tt>
- <dd> Matches a string from the string set <tt>{<i>ab, cde, cfh</i>}</tt>
- </dl>
- </dd>
- </dl>
- @param pathPattern a regular expression specifying a pth pattern
- @return an array of paths that match the path pattern
- @throws IOException]]>
- </doc>
- </method>
- <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathPattern" type="org.apache.hadoop.fs.Path"/>
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array of FileStatus objects whose path names match pathPattern
- and is accepted by the user-supplied path filter. Results are sorted by
- their path names.
- Return null if pathPattern has no glob and the path does not exist.
- Return an empty array if pathPattern has a glob and no path matches it.
-
- @param pathPattern
- a regular expression specifying the path pattern
- @param filter
- a user-supplied path filter
- @return an array of FileStatus objects
- @throws IOException if any I/O error occurs when fetching file status]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the current user's home directory in this filesystem.
- The default implementation returns "/user/$USER/".]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a new delegation token for this file system.
- @param renewer the account name that is allowed to renew the token.
- @return a new delegation token
- @throws IOException]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="new_dir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the current working directory for the given file system. All relative
- paths will be resolved relative to it.
-
- @param new_dir]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory for the given file system
- @return the directory pathname]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Call {@link #mkdirs(Path, FsPermission)} with default permission.]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make the given file and all non-existent parents into
- directories. Has the semantics of Unix 'mkdir -p'.
- Existence of the directory hierarchy is not an error.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name and the source is kept intact afterwards]]>
- </doc>
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src files is on the local disk. Add it to FS at
- the given dst name, removing the source afterwards.]]>
- </doc>
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name, removing the source afterwards.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src files are on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.]]>
- </doc>
- </method>
- <method name="moveToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- Remove the source afterwards]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- delSrc indicates if the src will be removed or not.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a local File that the user can write output to. The caller
- provides both the eventual FS target name and the local working
- file. If the FS is local, we write directly into the target. If
- the FS is remote, we write into the tmp local area.]]>
- </doc>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when we're all done writing to the target. A local FS will
- do nothing, because we've written to exactly the right place. A remote
- FS will copy the contents of tmpLocalFile to the correct target at
- fsOutputFile.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[No more filesystem operations are needed. Will
- release any held locks.]]>
- </doc>
- </method>
- <method name="getUsed" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the total size of all files in the filesystem.]]>
- </doc>
- </method>
- <method name="getBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use getFileStatus() instead">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use getFileStatus() instead]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getDefaultBlockSize(Path)} instead">
- <doc>
- <![CDATA[Return the number of bytes that large input files should be optimally
- be split into to minimize i/o time.
- @deprecated use {@link #getDefaultBlockSize(Path)} instead]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Return the number of bytes that large input files should be optimally
- be split into to minimize i/o time.
- @param f path of file
- @return the default block size for the path's filesystem]]>
- </doc>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getDefaultReplication(Path)} instead">
- <doc>
- <![CDATA[Get the default replication.
- @deprecated use {@link #getDefaultReplication(Path)} instead]]>
- </doc>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the default replication.
- @param path of the file
- @return default replication for the path's filesystem]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a file status object that represents the path.
- @param f The path we want information from
- @return a FileStatus object
- @throws FileNotFoundException when the path does not exist;
- IOException see specific implementation]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the checksum of a file.
- @param f The file path
- @return The file checksum. The default return value is null,
- which indicates that no checksum algorithm is implemented
- in the corresponding FileSystem.]]>
- </doc>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <doc>
- <![CDATA[Set the verify checksum flag. This is only applicable if the
- corresponding FileSystem supports checksum. By default doesn't do anything.
- @param verifyChecksum]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set permission of a path.
- @param p
- @param permission]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set owner of a path (i.e. a file or a directory).
- The parameters username and groupname cannot both be null.
- @param p The path
- @param username If it is null, the original username remains unchanged.
- @param groupname If it is null, the original groupname remains unchanged.]]>
- </doc>
- </method>
- <method name="setTimes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="mtime" type="long"/>
- <param name="atime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set access time of a file
- @param p The path
- @param mtime Set the modification time of this file.
- The number of milliseconds since Jan 1, 1970.
- A value of -1 means that this call should not set modification time.
- @param atime Set the access time of this file.
- The number of milliseconds since Jan 1, 1970.
- A value of -1 means that this call should not set access time.]]>
- </doc>
- </method>
- <method name="getStatistics" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="use {@link #getAllStatistics} instead">
- <doc>
- <![CDATA[Get the Map of Statistics object indexed by URI Scheme.
- @return a Map having a key as URI scheme and value as Statistics object
- @deprecated use {@link #getAllStatistics} instead]]>
- </doc>
- </method>
- <method name="getAllStatistics" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the FileSystem classes that have Statistics]]>
- </doc>
- </method>
- <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <param name="cls" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the statistics for a particular file system
- @param cls the class to lookup
- @return a statistics object]]>
- </doc>
- </method>
- <method name="clearStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStatistics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The statistics for this file system.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An abstract base class for a fairly generic filesystem. It
- may be implemented as a distributed filesystem, or as a "local"
- one that reflects the locally-connected disk. The local version
- exists for small Hadoop instances and for testing.
- <p>
- All user code that may potentially use the Hadoop Distributed
- File System should be written to use a FileSystem object. The
- Hadoop DFS is a multi-machine system that appears as a single
- disk. It's useful because of its fault tolerance and potentially
- very large capacity.
-
- <p>
- The local implementation is {@link LocalFileSystem} and distributed
- implementation is DistributedFileSystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileSystem -->
- <!-- start class org.apache.hadoop.fs.FileSystem.Statistics -->
- <class name="FileSystem.Statistics" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileSystem.Statistics" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="incrementBytesRead"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newBytes" type="long"/>
- <doc>
- <![CDATA[Increment the bytes read in the statistics
- @param newBytes the additional bytes read]]>
- </doc>
- </method>
- <method name="incrementBytesWritten"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newBytes" type="long"/>
- <doc>
- <![CDATA[Increment the bytes written in the statistics
- @param newBytes the additional bytes written]]>
- </doc>
- </method>
- <method name="incrementReadOps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[Increment the number of read operations
- @param count number of read operations]]>
- </doc>
- </method>
- <method name="incrementLargeReadOps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[Increment the number of large read operations
- @param count number of large read operations]]>
- </doc>
- </method>
- <method name="incrementWriteOps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[Increment the number of write operations
- @param count number of write operations]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of bytes read
- @return the number of bytes]]>
- </doc>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of bytes written
- @return the number of bytes]]>
- </doc>
- </method>
- <method name="getReadOps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of file system read operations such as list files
- @return number of read operations]]>
- </doc>
- </method>
- <method name="getLargeReadOps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of large file system read operations such as list files
- under a large directory
- @return number of large read operations]]>
- </doc>
- </method>
- <method name="getWriteOps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of file system write operations such as create, append
- rename etc.
- @return number of write operations]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the counts of bytes to 0.]]>
- </doc>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the uri scheme associated with this statistics object.
- @return the schema associated with this set of statistics]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.fs.FileSystem.Statistics -->
- <!-- start class org.apache.hadoop.fs.FileUtil -->
- <class name="FileUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
- <doc>
- <![CDATA[convert an array of FileStatus to an array of Path
-
- @param stats
- an array of FileStatus objects
- @return an array of paths corresponding to the input]]>
- </doc>
- </method>
- <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[convert an array of FileStatus to an array of Path.
- If stats if null, return path
- @param stats
- an array of FileStatus objects
- @param path
- default path to return in stats is null
- @return an array of paths corresponding to the input]]>
- </doc>
- </method>
- <method name="fullyDelete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a directory and all its contents. If
- we return false, the directory may be partially-deleted.]]>
- </doc>
- </method>
- <method name="fullyDeleteContents" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the contents of a directory, not the directory itself. If
- we return false, the directory may be partially-deleted.]]>
- </doc>
- </method>
- <method name="fullyDelete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link FileSystem#delete(Path, boolean)}">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Recursively delete a directory.
-
- @param fs {@link FileSystem} on which the path is present
- @param dir directory to recursively delete
- @throws IOException
- @deprecated Use {@link FileSystem#delete(Path, boolean)}]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy files between FileSystems.]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="srcs" type="org.apache.hadoop.fs.Path[]"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="overwrite" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy files between FileSystems.]]>
- </doc>
- </method>
- <method name="copyMerge" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="srcDir" type="org.apache.hadoop.fs.Path"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dstFile" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="addString" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy all files in a directory to one output file (merge).]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.io.File"/>
- <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy local files to a FileSystem.]]>
- </doc>
- </method>
- <method name="copy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="java.io.File"/>
- <param name="deleteSource" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy FileSystem files to local files.]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param filename The filename to convert
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param file The filename to convert
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="makeShellPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <param name="makeCanonicalPath" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a os-native filename to a path that works for the shell.
- @param file The filename to convert
- @param makeCanonicalPath
- Whether to make canonical path for the file passed
- @return The unix pathname
- @throws IOException on windows, there can be problems with the subprocess]]>
- </doc>
- </method>
- <method name="getDU" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Takes an input dir and returns the du on that local directory. Very basic
- implementation.
-
- @param dir
- The input dir to get the disk space of this local dir
- @return The total disk space of the input local directory]]>
- </doc>
- </method>
- <method name="unZip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFile" type="java.io.File"/>
- <param name="unzipDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Given a File input it will unzip the file in a the unzip directory
- passed as the second parameter
- @param inFile The zip file as input
- @param unzipDir The unzip directory where to unzip the zip file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="unTar"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFile" type="java.io.File"/>
- <param name="untarDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Given a Tar File as input it will untar the file in a the untar directory
- passed as the second parameter
-
- This utility will untar ".tar" files and ".tar.gz","tgz" files.
-
- @param inFile The tar file as input.
- @param untarDir The untar directory where to untar the tar file.
- @throws IOException]]>
- </doc>
- </method>
- <method name="symLink" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="java.lang.String"/>
- <param name="linkname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a soft link between a src and destination
- only on a local disk. HDFS does not support this
- @param target the target for symlink
- @param linkname the symlink
- @return value returned by the command]]>
- </doc>
- </method>
- <method name="chmod" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="perm" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Change the permissions on a filename.
- @param filename the name of the file to change
- @param perm the permission string
- @return the exit code from the command
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="chmod" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="perm" type="java.lang.String"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Change the permissions on a file / directory, recursively, if
- needed.
- @param filename name of the file whose permissions are to change
- @param perm permission string
- @param recursive true, if permissions should be changed recursively
- @return the exit code from the command.
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set permissions to the required value. Uses the java primitives instead
- of forking if group == other.
- @param f the file to change
- @param permission the new permissions
- @throws IOException]]>
- </doc>
- </method>
- <method name="createLocalTempFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="basefile" type="java.io.File"/>
- <param name="prefix" type="java.lang.String"/>
- <param name="isDeleteOnExit" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a tmp file for a base file.
- @param basefile the base file of the tmp
- @param prefix file name prefix of tmp
- @param isDeleteOnExit if true, the tmp will be deleted when the VM exits
- @return a newly created tmp file
- @exception IOException If a tmp file cannot created
- @see java.io.File#createTempFile(String, String, File)
- @see java.io.File#deleteOnExit()]]>
- </doc>
- </method>
- <method name="replaceFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.io.File"/>
- <param name="target" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the src file to the name specified by target.
- @param src the source file
- @param target the target file
- @exception IOException If this operation fails]]>
- </doc>
- </method>
- <method name="listFiles" return="java.io.File[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A wrapper for {@link File#listFiles()}. This java.io API returns null
- when a dir is not a directory or for any I/O error. Instead of having
- null check everywhere File#listFiles() is used, we will add utility API
- to get around this problem. For the majority of cases where we prefer
- an IOException to be thrown.
- @param dir directory for which listing should be performed
- @return list of files or empty list
- @exception IOException for invalid directory or for a bad disk.]]>
- </doc>
- </method>
- <method name="list" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A wrapper for {@link File#list()}. This java.io API returns null
- when a dir is not a directory or for any I/O error. Instead of having
- null check everywhere File#list() is used, we will add utility API
- to get around this problem. For the majority of cases where we prefer
- an IOException to be thrown.
- @param dir directory for which listing should be performed
- @return list of file names or empty string list
- @exception IOException for invalid directory or for a bad disk.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A collection of file-processing util methods]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FileUtil -->
- <!-- start class org.apache.hadoop.fs.FilterFileSystem -->
- <class name="FilterFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FilterFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FilterFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called after a new FileSystem instance is constructed.
- @param name a uri whose authority section names the host, port, etc.
- for this FileSystem
- @param conf the configuration]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]>
- </doc>
- </method>
- <method name="getCanonicalServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="call #getUri() instead.">
- <doc>
- <![CDATA[@deprecated call #getUri() instead.]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Make sure that a path specifies a FileSystem.]]>
- </doc>
- </method>
- <method name="checkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Check that a Path belongs to this FileSystem.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Opens an FSDataInputStream at the indicated Path.
- @param f the file name to open
- @param bufferSize the size of the buffer to be used.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="concat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="psrcs" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set replication for an existing file.
-
- @param src file name
- @param replication new replication
- @throws IOException
- @return true if successful;
- false if file does not exist or is a directory]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames Path src to Path dst. Can take place on local fs
- or remote DFS.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete a file]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List files in a directory.]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the current working directory for the given file system. All relative
- paths will be resolved relative to it.
-
- @param newDir]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory for the given file system
-
- @return the directory pathname]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is on the local disk. Add it to FS at
- the given dst name.
- delSrc indicates if the source should be removed]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The src file is under FS, and the dst is on the local disk.
- Copy it from FS control to the local dst name.
- delSrc indicates if the src will be removed or not.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a local File that the user can write output to. The caller
- provides both the eventual FS target name and the local working
- file. If the FS is local, we write directly into the target. If
- the FS is remote, we write into the tmp local area.]]>
- </doc>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when we're all done writing to the target. A local FS will
- do nothing, because we've written to exactly the right place. A remote
- FS will copy the contents of tmpLocalFile to the correct target at
- fsOutputFile.]]>
- </doc>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of bytes that large input files should be optimally
- be split into to minimize i/o time.]]>
- </doc>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default replication.]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get file status.]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setVerifyChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <field name="fs" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A <code>FilterFileSystem</code> contains
- some other file system, which it uses as
- its basic file system, possibly transforming
- the data along the way or providing additional
- functionality. The class <code>FilterFileSystem</code>
- itself simply overrides all methods of
- <code>FileSystem</code> with versions that
- pass all requests to the contained file
- system. Subclasses of <code>FilterFileSystem</code>
- may further override some of these methods
- and may also provide additional methods
- and fields.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FilterFileSystem -->
- <!-- start class org.apache.hadoop.fs.FSDataInputStream -->
- <class name="FSDataInputStream" extends="java.io.DataInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <implements name="org.apache.hadoop.fs.PositionedReadable"/>
- <implements name="java.io.Closeable"/>
- <implements name="org.apache.hadoop.fs.HasFileDescriptor"/>
- <constructor name="FSDataInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="seek"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="desired" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileDescriptor" return="java.io.FileDescriptor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Utility that wraps a {@link FSInputStream} in a {@link DataInputStream}
- and buffers input through a {@link BufferedInputStream}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSDataInputStream -->
- <!-- start class org.apache.hadoop.fs.FSDataOutputStream -->
- <class name="FSDataOutputStream" extends="java.io.DataOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Syncable"/>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getWrappedStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="sync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Utility that wraps a {@link OutputStream} in a {@link DataOutputStream},
- buffers output through a {@link BufferedOutputStream} and creates a checksum
- file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSDataOutputStream -->
- <!-- start class org.apache.hadoop.fs.FSError -->
- <class name="FSError" extends="java.lang.Error"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Thrown for unexpected filesystem errors, presumed to reflect disk errors
- in the native filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSError -->
- <!-- start class org.apache.hadoop.fs.FSInputChecker -->
- <class name="FSInputChecker" extends="org.apache.hadoop.fs.FSInputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FSInputChecker" type="org.apache.hadoop.fs.Path, int"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
-
- @param file The name of the file to be read
- @param numOfRetries Number of read retries when ChecksumError occurs]]>
- </doc>
- </constructor>
- <constructor name="FSInputChecker" type="org.apache.hadoop.fs.Path, int, boolean, java.util.zip.Checksum, int, int"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
-
- @param file The name of the file to be read
- @param numOfRetries Number of read retries when ChecksumError occurs
- @param sum the type of Checksum engine
- @param chunkSize maximun chunk size
- @param checksumSize the number byte of each checksum]]>
- </doc>
- </constructor>
- <method name="readChunk" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="len" type="int"/>
- <param name="checksum" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads in next checksum chunk data into <code>buf</code> at <code>offset</code>
- and checksum into <code>checksum</code>.
- The method is used for implementing read, therefore, it should be optimized
- for sequential reading
- @param pos chunkPos
- @param buf desitination buffer
- @param offset offset in buf at which to store data
- @param len maximun number of bytes to read
- @return number of bytes read]]>
- </doc>
- </method>
- <method name="getChunkPosition" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <doc>
- <![CDATA[Return position of beginning of chunk containing pos.
- @param pos a postion in the file
- @return the starting position of the chunk which contains the byte]]>
- </doc>
- </method>
- <method name="needChecksum" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if there is a need for checksum verification]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read one checksum-verified byte
-
- @return the next byte of data, or <code>-1</code> if the end of the
- stream is reached.
- @exception IOException if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read checksum verified bytes from this byte-input stream into
- the specified byte array, starting at the given offset.
- <p> This method implements the general contract of the corresponding
- <code>{@link InputStream#read(byte[], int, int) read}</code> method of
- the <code>{@link InputStream}</code> class. As an additional
- convenience, it attempts to read as many bytes as possible by repeatedly
- invoking the <code>read</code> method of the underlying stream. This
- iterated <code>read</code> continues until one of the following
- conditions becomes true: <ul>
- <li> The specified number of bytes have been read,
- <li> The <code>read</code> method of the underlying stream returns
- <code>-1</code>, indicating end-of-file.
- </ul> If the first <code>read</code> on the underlying stream returns
- <code>-1</code> to indicate end-of-file then this method returns
- <code>-1</code>. Otherwise this method returns the number of bytes
- actually read.
- @param b destination buffer.
- @param off offset at which to start storing bytes.
- @param len maximum number of bytes to read.
- @return the number of bytes read, or <code>-1</code> if the end of
- the stream has been reached.
- @exception IOException if an I/O error occurs.
- ChecksumException if any checksum error occurs]]>
- </doc>
- </method>
- <method name="checksum2long" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="checksum" type="byte[]"/>
- <doc>
- <![CDATA[Convert a checksum byte array to a long]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="available" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skips over and discards <code>n</code> bytes of data from the
- input stream.
- <p>This method may skip more bytes than are remaining in the backing
- file. This produces no exception and the number of bytes skipped
- may include some number of bytes that were beyond the EOF of the
- backing file. Attempting to read from the stream after skipping past
- the end will result in -1 indicating the end of the file.
- <p>If <code>n</code> is negative, no bytes are skipped.
- @param n the number of bytes to be skipped.
- @return the actual number of bytes skipped.
- @exception IOException if an I/O error occurs.
- ChecksumException if the chunk to skip to is corrupted]]>
- </doc>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given position in the stream.
- The next read() will be from that position.
-
- <p>This method may seek past the end of the file.
- This produces no exception and an attempt to read from
- the stream will result in -1 indicating the end of the file.
- @param pos the postion to seek to.
- @exception IOException if an I/O error occurs.
- ChecksumException if the chunk to seek to is corrupted]]>
- </doc>
- </method>
- <method name="readFully" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="stm" type="java.io.InputStream"/>
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A utility function that tries to read up to <code>len</code> bytes from
- <code>stm</code>
-
- @param stm an input stream
- @param buf destiniation buffer
- @param offset offset at which to store data
- @param len number of bytes to read
- @return actual number of bytes read
- @throws IOException if there is any IO error]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="true"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="verifyChecksum" type="boolean"/>
- <param name="sum" type="java.util.zip.Checksum"/>
- <param name="maxChunkSize" type="int"/>
- <param name="checksumSize" type="int"/>
- <doc>
- <![CDATA[Set the checksum related parameters
- @param verifyChecksum whether to verify checksum
- @param sum which type of checksum to use
- @param maxChunkSize maximun chunk size
- @param checksumSize checksum size]]>
- </doc>
- </method>
- <method name="markSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="mark"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="readlimit" type="int"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="file" type="org.apache.hadoop.fs.Path"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The file name from which data is read from]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This is a generic input stream for verifying checksums for
- data before it is read by a user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSInputChecker -->
- <!-- start class org.apache.hadoop.fs.FSInputStream -->
- <class name="FSInputStream" extends="java.io.InputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <implements name="org.apache.hadoop.fs.PositionedReadable"/>
- <constructor name="FSInputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="seek"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given offset from the start of the file.
- The next read() will be from that location. Can't
- seek past the end of the file.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current offset from the start of the file]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seeks a different copy of the data. Returns true if
- found a new source, false otherwise.]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[FSInputStream is a generic old InputStream with a little bit
- of RAF-style seek ability.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSInputStream -->
- <!-- start class org.apache.hadoop.fs.FSOutputSummer -->
- <class name="FSOutputSummer" extends="java.io.OutputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FSOutputSummer" type="java.util.zip.Checksum, int, int"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="writeChunk"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="len" type="int"/>
- <param name="checksum" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write one byte]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes <code>len</code> bytes from the specified byte array
- starting at offset <code>off</code> and generate a checksum for
- each data chunk.
- <p> This method stores bytes from the given array into this
- stream's buffer before it gets checksumed. The buffer gets checksumed
- and flushed to the underlying output stream when all data
- in a checksum chunk are in the buffer. If the buffer is empty and
- requested length is at least as large as the size of next checksum chunk
- size, this method will checksum and write the chunk directly
- to the underlying output stream. Thus it avoids uneccessary data copy.
- @param b the data.
- @param off the start offset in the data.
- @param len the number of bytes to write.
- @exception IOException if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="flushBuffer"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flushBuffer"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="keep" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="convertToByteStream" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sum" type="java.util.zip.Checksum"/>
- <param name="checksumSize" type="int"/>
- <doc>
- <![CDATA[Converts a checksum integer value to a byte stream]]>
- </doc>
- </method>
- <method name="resetChecksumChunk"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="size" type="int"/>
- <doc>
- <![CDATA[Resets existing buffer with a new one of the specified size.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is a generic output stream for generating checksums for
- data before it is written to the underlying stream]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FSOutputSummer -->
- <!-- start class org.apache.hadoop.fs.FsShell -->
- <class name="FsShell" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="FsShell"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsShell" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFS" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTrash" return="org.apache.hadoop.fs.Trash"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCurrentTrashDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the Trash object associated with this shell.]]>
- </doc>
- </method>
- <method name="byteDesc" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Consider using {@link org.apache.hadoop.util.StringUtils#byteDesc} instead.">
- <param name="len" type="long"/>
- <doc>
- <![CDATA[Return an abbreviated English-language desc of the byte length
- @deprecated Consider using {@link org.apache.hadoop.util.StringUtils#byteDesc} instead.]]>
- </doc>
- </method>
- <method name="limitDecimalTo2" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="Consider using {@link org.apache.hadoop.util.StringUtils#limitDecimalTo2} instead.">
- <param name="d" type="double"/>
- <doc>
- <![CDATA[@deprecated Consider using {@link org.apache.hadoop.util.StringUtils#limitDecimalTo2} instead.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[run]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[main() has some simple utility methods]]>
- </doc>
- </method>
- <field name="dateForm" type="java.text.SimpleDateFormat"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="modifFmt" type="java.text.SimpleDateFormat"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Provide command line access to a FileSystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FsShell -->
- <!-- start class org.apache.hadoop.fs.FsUrlStreamHandlerFactory -->
- <class name="FsUrlStreamHandlerFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.net.URLStreamHandlerFactory"/>
- <constructor name="FsUrlStreamHandlerFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FsUrlStreamHandlerFactory" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createURLStreamHandler" return="java.net.URLStreamHandler"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Factory for URL stream handlers.
-
- There is only one handler whose job is to create UrlConnections. A
- FsUrlConnection relies on FileSystem to choose the appropriate FS
- implementation.
-
- Before returning our handler, we make sure that FileSystem knows an
- implementation for the requested scheme/protocol.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.FsUrlStreamHandlerFactory -->
- <!-- start class org.apache.hadoop.fs.GlobPattern -->
- <class name="GlobPattern" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GlobPattern" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the glob pattern object with a glob pattern string
- @param globPattern the glob pattern string]]>
- </doc>
- </constructor>
- <method name="compiled" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the compiled pattern]]>
- </doc>
- </method>
- <method name="compile" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="globPattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Compile glob pattern string
- @param globPattern the glob pattern
- @return the pattern object]]>
- </doc>
- </method>
- <method name="matches" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.CharSequence"/>
- <doc>
- <![CDATA[Match input against the compiled glob pattern
- @param s input chars
- @return true for successful matches]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="glob" type="java.lang.String"/>
- <doc>
- <![CDATA[Set and compile a glob pattern
- @param glob the glob pattern string]]>
- </doc>
- </method>
- <method name="hasWildcard" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this is a wildcard pattern (with special chars)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class for POSIX glob pattern with brace expansions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.GlobPattern -->
- <!-- start class org.apache.hadoop.fs.HardLink -->
- <class name="HardLink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HardLink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLinkMultArgLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fileDir" type="java.io.File"/>
- <param name="fileBaseNames" type="java.lang.String[]"/>
- <param name="linkDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Calculate the nominal length of all contributors to the total
- commandstring length, including fixed overhead of the OS-dependent
- command. It's protected rather than private, to assist unit testing,
- but real clients are not expected to need it -- see the way
- createHardLinkMult() uses it internally so the user doesn't need to worry
- about it.
-
- @param fileDir - source directory, parent of fileBaseNames
- @param fileBaseNames - array of path-less file names, relative
- to the source directory
- @param linkDir - target directory where the hardlinks will be put
- @return - total data length (must not exceed maxAllowedCmdArgLength)
- @throws IOException]]>
- </doc>
- </method>
- <method name="getMaxAllowedCmdArgLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this private value for use by unit tests.
- Shell commands are not allowed to have a total string length
- exceeding this size.]]>
- </doc>
- </method>
- <method name="createHardLink"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <param name="linkName" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a hardlink
- @param file - existing source file
- @param linkName - desired target link file]]>
- </doc>
- </method>
- <method name="createHardLinkMult"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parentDir" type="java.io.File"/>
- <param name="fileBaseNames" type="java.lang.String[]"/>
- <param name="linkDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates hardlinks from multiple existing files within one parent
- directory, into one target directory.
- @param parentDir - directory containing source files
- @param fileBaseNames - list of path-less file names, as returned by
- parentDir.list()
- @param linkDir - where the hardlinks should be put. It must already exist.
-
- If the list of files is too long (overflows maxAllowedCmdArgLength),
- we will automatically split it into multiple invocations of the
- underlying method.]]>
- </doc>
- </method>
- <method name="createHardLinkMult" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="parentDir" type="java.io.File"/>
- <param name="fileBaseNames" type="java.lang.String[]"/>
- <param name="linkDir" type="java.io.File"/>
- <param name="maxLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLinkCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileName" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieves the number of links to the specified file.]]>
- </doc>
- </method>
- <field name="osType" type="org.apache.hadoop.fs.HardLink.OSType"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="linkStats" type="org.apache.hadoop.fs.HardLink.LinkStats"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Class for creating hardlinks.
- Supports Unix/Linux, WinXP/2003/Vista via Cygwin, and Mac OS X.
-
- The HardLink class was formerly a static inner class of FSUtil,
- and the methods provided were blatantly non-thread-safe.
- To enable volume-parallel Update snapshots, we now provide static
- threadsafe methods that allocate new buffer string arrays
- upon each call. We also provide an API to hardlink all files in a
- directory with a single command, which is up to 128 times more
- efficient - and minimizes the impact of the extra buffer creations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.HardLink -->
- <!-- start class org.apache.hadoop.fs.HardLink.LinkStats -->
- <class name="HardLink.LinkStats" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HardLink.LinkStats"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="report" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="countDirs" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="countSingleLinks" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="countMultLinks" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="countFilesMultLinks" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="countEmptyDirs" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="countPhysicalFileCopies" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[HardLink statistics counters and methods.
- Not multi-thread safe, obviously.
- Init is called during HardLink instantiation, above.
-
- These are intended for use by knowledgeable clients, not internally,
- because many of the internal methods are static and can't update these
- per-instance counters.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.HardLink.LinkStats -->
- <!-- start class org.apache.hadoop.fs.HardLink.OSType -->
- <class name="HardLink.OSType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.HardLink.OSType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.HardLink.OSType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="OS_TYPE_UNIX" type="org.apache.hadoop.fs.HardLink.OSType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OS_TYPE_WINXP" type="org.apache.hadoop.fs.HardLink.OSType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OS_TYPE_SOLARIS" type="org.apache.hadoop.fs.HardLink.OSType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OS_TYPE_MAC" type="org.apache.hadoop.fs.HardLink.OSType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.fs.HardLink.OSType -->
- <!-- start class org.apache.hadoop.fs.HarFileSystem -->
- <class name="HarFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HarFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[public construction of harfilesystem]]>
- </doc>
- </constructor>
- <constructor name="HarFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor to create a HarFileSystem with an
- underlying filesystem.
- @param fs]]>
- </doc>
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize a Har filesystem per har archive. The
- archive home directory is the top level directory
- in the filesystem that contains the HAR archive.
- Be careful with this method, you do not want to go
- on creating new Filesystem instances per call to
- path.getFileSystem().
- the uri of Har is
- har://underlyingfsscheme-host:port/archivepath.
- or
- har:///archivepath. This assumes the underlying filesystem
- to be used in case not specified.]]>
- </doc>
- </method>
- <method name="getHarVersion" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return the top level archive.]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the uri of this filesystem.
- The uri is of the form
- har://underlyingfsschema-host:port/pathintheunderlyingfs]]>
- </doc>
- </method>
- <method name="getCanonicalServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get block locations from the underlying fs and fix their
- offsets and lengths.
- @param file the input filestatus to get block locations
- @param start the start of the desired range in the contained file
- @param len the length of the desired range
- @return block locations for this segment of file
- @throws IOException]]>
- </doc>
- </method>
- <method name="getHarHash" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[the hash of the path p inside iniside
- the filesystem
- @param p the path in the harfilesystem
- @return the hash code of the path.]]>
- </doc>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[return the filestatus of files in har archive.
- The permission returned are that of the archive
- index files. The permissions are not persisted
- while creating a hadoop archive.
- @param f the path in har filesystem
- @return filestatus.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[@return null since no checksum algorithm is implemented.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a har input stream which fakes end of
- file. It reads the index files to get the part
- file name and the size and start of the file.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Not implemented.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Not implemented.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[liststatus returns the children of a directory
- after looking up the index files.]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return the top level archive path.]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[not implemented.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[not implemented.]]>
- </doc>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[copies the file in the har filesystem to a local file.]]>
- </doc>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[not implemented.]]>
- </doc>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[not implemented.]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[not implemented.]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permisssion" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Not implemented.]]>
- </doc>
- </method>
- <field name="VERSION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This is an implementation of the Hadoop Archive
- Filesystem. This archive Filesystem has index files
- of the form _index* and has contents of the form
- part-*. The index files store the indexes of the
- real files. The index files are of the form _masterindex
- and _index. The master index is a level of indirection
- in to the index file to make the look ups faster. the index
- file is sorted with hash code of the paths that it contains
- and the master index contains pointers to the positions in
- index for ranges of hashcodes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.HarFileSystem -->
- <!-- start interface org.apache.hadoop.fs.HasFileDescriptor -->
- <interface name="HasFileDescriptor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getFileDescriptor" return="java.io.FileDescriptor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return the FileDescriptor
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Having a FileDescriptor]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.HasFileDescriptor -->
- <!-- start class org.apache.hadoop.fs.InMemoryFileSystem -->
- <class name="InMemoryFileSystem" extends="org.apache.hadoop.fs.ChecksumFileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InMemoryFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InMemoryFileSystem" type="java.net.URI, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reserveSpaceWithCheckSum" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="size" type="long"/>
- <doc>
- <![CDATA[Register a file with its size. This will also register a checksum for the
- file that the user is trying to create. This is required since none of
- the FileSystem APIs accept the size of the file as argument. But since it
- is required for us to apriori know the size of the file we are going to
- create, the user must call this method for each file he wants to create
- and reserve memory for that file. We either succeed in reserving memory
- for both the main file and the checksum file and return true, or return
- false.]]>
- </doc>
- </method>
- <method name="getFiles" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- </method>
- <method name="getNumFiles" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.fs.PathFilter"/>
- </method>
- <method name="getFSSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPercentUsed" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[An implementation of the in-memory filesystem. This implementation assumes
- that the file lengths are known ahead of time and the total lengths of all
- the files is below a certain number (like 100 MB, configurable). Use the API
- reserveSpaceWithCheckSum(Path f, int size) (see below for a description of
- the API for reserving space in the FS. The uri of this filesystem starts with
- ramfs:// .]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.InMemoryFileSystem -->
- <!-- start class org.apache.hadoop.fs.LocalDirAllocator -->
- <class name="LocalDirAllocator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalDirAllocator" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an allocator object
- @param contextCfgItemName]]>
- </doc>
- </constructor>
- <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS. This method should be used if the size of
- the file is not known apriori. We go round-robin over the set of disks
- (via the configured dirs) and return the first complete path where
- we could create the parent directory of the passed path.
- @param pathStr the requested path (this will be created on the first
- available disk)
- @param conf the Configuration object
- @return the complete path to the file on a local disk
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="size" type="long"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS. Pass size as
- SIZE_UNKNOWN if not known apriori. We
- round-robin over the set of disks (via the configured dirs) and return
- the first complete path which has enough space
- @param pathStr the requested path (this will be created on the first
- available disk)
- @param size the size of the file that is going to be written
- @param conf the Configuration object
- @return the complete path to the file on a local disk
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="size" type="long"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="checkWrite" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS. Pass size as
- SIZE_UNKNOWN if not known apriori. We
- round-robin over the set of disks (via the configured dirs) and return
- the first complete path which has enough space
- @param pathStr the requested path (this will be created on the first
- available disk)
- @param size the size of the file that is going to be written
- @param conf the Configuration object
- @param checkWrite ensure that the path is writable
- @return the complete path to the file on a local disk
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocalPathToRead" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS for reading. We search through all the
- configured dirs for the file's existence and return the complete
- path to the file when we find one
- @param pathStr the requested file (this will be searched)
- @param conf the Configuration object
- @return the complete path to the file on a local disk
- @throws IOException]]>
- </doc>
- </method>
- <method name="getAllLocalPathsToRead" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all of the paths that currently exist in the working directories.
- @param pathStr the path underneath the roots
- @param conf the configuration to look up the roots in
- @return all of the paths that exist under any of the roots
- @throws IOException]]>
- </doc>
- </method>
- <method name="createTmpFileForWrite" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="size" type="long"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a temporary file in the local FS. Pass size as -1 if not known
- apriori. We round-robin over the set of disks (via the configured dirs)
- and select the first complete path which has enough space. A file is
- created on this directory. The file is guaranteed to go away when the
- JVM exits.
- @param pathStr prefix for the temporary file
- @param size the size of the file that is going to be written
- @param conf the Configuration object
- @return a unique temporary file
- @throws IOException]]>
- </doc>
- </method>
- <method name="isContextValid" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextCfgItemName" type="java.lang.String"/>
- <doc>
- <![CDATA[Method to check whether a context is valid
- @param contextCfgItemName
- @return true/false]]>
- </doc>
- </method>
- <method name="ifExists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathStr" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[We search through all the configured dirs for the file's existence
- and return true when we find
- @param pathStr the requested file (this will be searched)
- @param conf the Configuration object
- @return true if files exist. false otherwise
- @throws IOException]]>
- </doc>
- </method>
- <field name="SIZE_UNKNOWN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Used when size of file to be allocated is unknown.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An implementation of a round-robin scheme for disk allocation for creating
- files. The way it works is that it is kept track what disk was last
- allocated for a file write. For the current request, the next disk from
- the set of disks would be allocated if the free space on the disk is
- sufficient enough to accommodate the file that is being considered for
- creation. If the space requirements cannot be met, the next disk in order
- would be tried and so on till a disk is found with sufficient capacity.
- Once a disk with sufficient space is identified, a check is done to make
- sure that the disk is writable. Also, there is an API provided that doesn't
- take the space requirements into consideration but just checks whether the
- disk under consideration is writable (this should be used for cases where
- the file size is not known apriori). An API is provided to read a path that
- was created earlier. That API works by doing a scan of all the disks for the
- input pathname.
- This implementation also provides the functionality of having multiple
- allocators per JVM (one for each unique functionality or context, like
- mapred, dfs-client, etc.). It ensures that there is only one instance of
- an allocator per context per JVM.
- Note:
- 1. The contexts referred above are actually the configuration items defined
- in the Configuration class like "mapred.local.dir" (for which we want to
- control the dir allocations). The context-strings are exactly those
- configuration items.
- 2. This implementation does not take into consideration cases where
- a disk becomes read-only or goes out of space while a file is being written
- to (disks are shared between multiple processes, and so the latter situation
- is probable).
- 3. In the class implementation, "Disk" is referred to as "Dir", which
- actually points to the configured directory on the Disk which will be the
- parent for all file write/read allocations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.LocalDirAllocator -->
- <!-- start class org.apache.hadoop.fs.LocalFileSystem -->
- <class name="LocalFileSystem" extends="org.apache.hadoop.fs.ChecksumFileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LocalFileSystem" type="org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRaw" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="exists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get file status.]]>
- </doc>
- </method>
- <method name="pathToFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Convert a path to a File.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reportChecksumFailure" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="inPos" type="long"/>
- <param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
- <param name="sumsPos" type="long"/>
- <doc>
- <![CDATA[Moves files to a bad file directory on the same device, so that their
- storage will not be reused.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implement the FileSystem API for the checksumed local filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.LocalFileSystem -->
- <!-- start class org.apache.hadoop.fs.MD5MD5CRC32FileChecksum -->
- <class name="MD5MD5CRC32FileChecksum" extends="org.apache.hadoop.fs.FileChecksum"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MD5MD5CRC32FileChecksum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Same as this(0, 0, null)]]>
- </doc>
- </constructor>
- <constructor name="MD5MD5CRC32FileChecksum" type="int, long, org.apache.hadoop.io.MD5Hash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a MD5FileChecksum]]>
- </doc>
- </constructor>
- <method name="getAlgorithmName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="xml" type="org.znerd.xmlenc.XMLOutputter"/>
- <param name="that" type="org.apache.hadoop.fs.MD5MD5CRC32FileChecksum"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write that object to xml output.]]>
- </doc>
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.MD5MD5CRC32FileChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attrs" type="org.xml.sax.Attributes"/>
- <exception name="SAXException" type="org.xml.sax.SAXException"/>
- <doc>
- <![CDATA[Return the object represented in the attributes.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <field name="LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[MD5 of MD5 of CRC32.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.MD5MD5CRC32FileChecksum -->
- <!-- start class org.apache.hadoop.fs.Path -->
- <class name="Path" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Path" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resolve a child path against a parent path.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="org.apache.hadoop.fs.Path, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resolve a child path against a parent path.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resolve a child path against a parent path.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resolve a child path against a parent path.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a path from a String. Path strings are URIs, but with
- unescaped elements and some additional normalization.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a Path from components.]]>
- </doc>
- </constructor>
- <constructor name="Path" type="java.net.URI"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a path from a URI]]>
- </doc>
- </constructor>
- <method name="toUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert this to a URI.]]>
- </doc>
- </method>
- <method name="getFileSystem" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the FileSystem that owns this Path.]]>
- </doc>
- </method>
- <method name="isAbsolute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[True if the directory of this path is absolute.]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the final component of this path.]]>
- </doc>
- </method>
- <method name="getParent" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the parent of a path or null if at root.]]>
- </doc>
- </method>
- <method name="suffix" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="suffix" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds a suffix to the final name in the path.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="depth" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the number of elements in this path.]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <doc>
- <![CDATA[Returns a qualified path object.]]>
- </doc>
- </method>
- <method name="makeQualified" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultUri" type="java.net.URI"/>
- <param name="workingDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Returns a qualified path object.]]>
- </doc>
- </method>
- <field name="SEPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The directory separator, a slash.]]>
- </doc>
- </field>
- <field name="SEPARATOR_CHAR" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CUR_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Names a file or directory in a {@link FileSystem}.
- Path strings use slash as the directory separator. A path string is
- absolute if it begins with a slash.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.Path -->
- <!-- start interface org.apache.hadoop.fs.PathFilter -->
- <interface name="PathFilter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Tests whether or not the specified abstract pathname should be
- included in a pathname list.
- @param path The abstract pathname to be tested
- @return <code>true</code> if and only if <code>pathname</code>
- should be included]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.fs.PathFilter -->
- <!-- start interface org.apache.hadoop.fs.PositionedReadable -->
- <interface name="PositionedReadable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read upto the specified number of bytes, from a given
- position within a file, and return the number of bytes read. This does not
- change the current offset of a file, and is thread-safe.]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the specified number of bytes, from a given
- position within a file. This does not
- change the current offset of a file, and is thread-safe.]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <param name="buffer" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read number of bytes equalt to the length of the buffer, from a given
- position within a file. This does not
- change the current offset of a file, and is thread-safe.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stream that permits positional reading.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.PositionedReadable -->
- <!-- start class org.apache.hadoop.fs.RawLocalFileSystem -->
- <class name="RawLocalFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RawLocalFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="pathToFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Convert a path to a File.]]>
- </doc>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createNonRecursive" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates the specified directory hierarchy. Does not
- treat existence as an error.]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the working directory to the given directory.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="moveFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsWorkingFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Use the command chown to set owner.]]>
- </doc>
- </method>
- <method name="setPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Use the command chmod to set permission.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implement the FileSystem API for the raw local filesystem.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.RawLocalFileSystem -->
- <!-- start interface org.apache.hadoop.fs.Seekable -->
- <interface name="Seekable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the given offset from the start of the file.
- The next read() will be from that location. Can't
- seek past the end of the file.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current offset from the start of the file]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seeks a different copy of the data. Returns true if
- found a new source, false otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stream that permits seeking.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.Seekable -->
- <!-- start interface org.apache.hadoop.fs.Syncable -->
- <interface name="Syncable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="sync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Synchronize all buffer with the underlying devices.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This interface declare the sync() operation.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.Syncable -->
- <!-- start class org.apache.hadoop.fs.Trash -->
- <class name="Trash" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Trash" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a trash can accessor.
- @param conf a Configuration]]>
- </doc>
- </constructor>
- <constructor name="Trash" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a trash can accessor for the FileSystem provided.]]>
- </doc>
- </constructor>
- <method name="moveToTrash" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move a file or directory to the current trash directory.
- @return false if the item is already in the trash or trash is disabled]]>
- </doc>
- </method>
- <method name="checkpoint"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a trash checkpoint.]]>
- </doc>
- </method>
- <method name="expunge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete old checkpoints.]]>
- </doc>
- </method>
- <method name="getEmptier" return="java.lang.Runnable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a {@link Runnable} that periodically empties the trash of all
- users, intended to be run by the superuser. Only one checkpoint is kept
- at a time.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Run an emptier.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provides a <i>trash</i> feature. Files are moved to a user's trash
- directory, a subdirectory of their home directory named ".Trash". Files are
- initially moved to a <i>current</i> sub-directory of the trash directory.
- Within that sub-directory their original path is preserved. Periodically
- one may checkpoint the current trash and remove older checkpoints. (This
- design permits trash management without enumeration of the full trash
- content, without date support in the filesystem, and without clock
- synchronization.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.Trash -->
- </package>
- <package name="org.apache.hadoop.fs.ftp">
- <!-- start class org.apache.hadoop.fs.ftp.FTPException -->
- <class name="FTPException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FTPException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FTPException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FTPException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A class to wrap a {@link Throwable} into a Runtime Exception.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ftp.FTPException -->
- <!-- start class org.apache.hadoop.fs.ftp.FTPFileSystem -->
- <class name="FTPFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FTPFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A stream obtained via this call must be closed before using other APIs of
- this class or else the invocation will block.]]>
- </doc>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This optional operation is not yet supported.]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use delete(Path, boolean) instead">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use delete(Path, boolean) instead]]>
- </doc>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BUFFER_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BLOCK_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- A {@link FileSystem} backed by an FTP client provided by <a
- href="http://commons.apache.org/net/">Apache Commons Net</a>.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.ftp.FTPFileSystem -->
- <!-- start class org.apache.hadoop.fs.ftp.FTPInputStream -->
- <class name="FTPInputStream" extends="org.apache.hadoop.fs.FSInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FTPInputStream" type="java.io.InputStream, org.apache.commons.net.ftp.FTPClient, org.apache.hadoop.fs.FileSystem.Statistics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="markSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="mark"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readLimit" type="int"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.fs.ftp.FTPInputStream -->
- </package>
- <package name="org.apache.hadoop.fs.kfs">
- <!-- start class org.apache.hadoop.fs.kfs.KosmosFileSystem -->
- <class name="KosmosFileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KosmosFileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="isDirectory" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This optional operation is not yet supported.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDefaultReplication" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setReplication" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="replication" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDefaultBlockSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="lock"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="shared" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="release"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="start" type="long"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return null if the file doesn't exist; otherwise, get the
- locations of the various chunks of the file file from KFS.]]>
- </doc>
- </method>
- <method name="copyFromLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="copyToLocalFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delSrc" type="boolean"/>
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="completeLocalOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A FileSystem backed by KFS.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.kfs.KosmosFileSystem -->
- </package>
- <package name="org.apache.hadoop.fs.permission">
- <!-- start class org.apache.hadoop.fs.permission.AccessControlException -->
- <class name="AccessControlException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.security.AccessControlException}
- instead.">
- <constructor name="AccessControlException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor is needed for unwrapping from
- {@link org.apache.hadoop.ipc.RemoteException}.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an {@link AccessControlException}
- with the specified detail message.
- @param s the detail message.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[An exception class for access control related issues.
- @deprecated Use {@link org.apache.hadoop.security.AccessControlException}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.AccessControlException -->
- <!-- start class org.apache.hadoop.fs.permission.ChmodParser -->
- <class name="ChmodParser" extends="org.apache.hadoop.fs.permission.PermissionParser"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChmodParser" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- </constructor>
- <method name="applyNewPermission" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.FileStatus"/>
- <doc>
- <![CDATA[Apply permission against specified file and determine what the
- new mode would be
- @param file File against which to apply mode
- @return File's new mode if applied.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Parse a permission mode passed in from a chmod command and apply that
- mode against an existing file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.ChmodParser -->
- <!-- start class org.apache.hadoop.fs.permission.FsAction -->
- <class name="FsAction" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.fs.permission.FsAction[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="implies" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[Return true if this action implies that action.
- @param that]]>
- </doc>
- </method>
- <method name="and" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[AND operation.]]>
- </doc>
- </method>
- <method name="or" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.fs.permission.FsAction"/>
- <doc>
- <![CDATA[OR operation.]]>
- </doc>
- </method>
- <method name="not" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NOT operation.]]>
- </doc>
- </method>
- <field name="NONE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EXECUTE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WRITE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WRITE_EXECUTE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READ" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READ_EXECUTE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READ_WRITE" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ALL" type="org.apache.hadoop.fs.permission.FsAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SYMBOL" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Symbolic representation]]>
- </doc>
- </field>
- <doc>
- <![CDATA[File system actions, e.g. read, write, etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.FsAction -->
- <!-- start class org.apache.hadoop.fs.permission.FsPermission -->
- <class name="FsPermission" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by the given {@link FsAction}.
- @param u user action
- @param g group action
- @param o other action]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="short"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by the given mode.
- @param mode
- @see #toShort()]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsPermission"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor
-
- @param other other permission]]>
- </doc>
- </constructor>
- <constructor name="FsPermission" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct by given mode, either in octal or symbolic format.
- @param mode mode as a string, either in octal or symbolic format
- @throws IllegalArgumentException if <code>mode</code> is invalid]]>
- </doc>
- </constructor>
- <method name="createImmutable" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="permission" type="short"/>
- <doc>
- <![CDATA[Create an immutable {@link FsPermission} object.]]>
- </doc>
- </method>
- <method name="getUserAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return user {@link FsAction}.]]>
- </doc>
- </method>
- <method name="getGroupAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return group {@link FsAction}.]]>
- </doc>
- </method>
- <method name="getOtherAction" return="org.apache.hadoop.fs.permission.FsAction"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return other {@link FsAction}.]]>
- </doc>
- </method>
- <method name="fromShort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="short"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="read" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create and initialize a {@link FsPermission} from {@link DataInput}.]]>
- </doc>
- </method>
- <method name="toShort" return="short"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Encode the object to a short.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="applyUMask" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Apply a umask to this permission and return a new one]]>
- </doc>
- </method>
- <method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the user file creation mask (umask)
-
- {@code UMASK_LABEL} config param has umask value that is either symbolic
- or octal.
-
- Symbolic umask is applied relative to file mode creation mask;
- the permission op characters '+' clears the corresponding bit in the mask,
- '-' sets bits in the mask.
-
- Octal umask, the specified bits are set in the file mode creation mask.
-
- {@code DEPRECATED_UMASK_LABEL} config param has umask value set to decimal.]]>
- </doc>
- </method>
- <method name="setUMask"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Set the user file creation mask (umask)]]>
- </doc>
- </method>
- <method name="getDefault" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default permission.]]>
- </doc>
- </method>
- <method name="valueOf" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="unixSymbolicPermission" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a FsPermission from a Unix symbolic permission string
- @param unixSymbolicPermission e.g. "-rw-rw-rw-"]]>
- </doc>
- </method>
- <field name="DEPRECATED_UMASK_LABEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[umask property label]]>
- </doc>
- </field>
- <field name="UMASK_LABEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_UMASK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A class for file/directory permissions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.FsPermission -->
- <!-- start class org.apache.hadoop.fs.permission.PermissionStatus -->
- <class name="PermissionStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="PermissionStatus" type="java.lang.String, java.lang.String, org.apache.hadoop.fs.permission.FsPermission"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor]]>
- </doc>
- </constructor>
- <method name="createImmutable" return="org.apache.hadoop.fs.permission.PermissionStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="group" type="java.lang.String"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Create an immutable {@link PermissionStatus} object.]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return user name]]>
- </doc>
- </method>
- <method name="getGroupName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return group name]]>
- </doc>
- </method>
- <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return permission]]>
- </doc>
- </method>
- <method name="applyUMask" return="org.apache.hadoop.fs.permission.PermissionStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <doc>
- <![CDATA[Apply umask.
- @see FsPermission#applyUMask(FsPermission)]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="read" return="org.apache.hadoop.fs.permission.PermissionStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create and initialize a {@link PermissionStatus} from {@link DataInput}.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="username" type="java.lang.String"/>
- <param name="groupname" type="java.lang.String"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a {@link PermissionStatus} from its base components.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Store permission related information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.permission.PermissionStatus -->
- </package>
- <package name="org.apache.hadoop.fs.s3">
- <!-- start class org.apache.hadoop.fs.s3.Block -->
- <class name="Block" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Block" type="long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Holds metadata about a block of data being stored in a {@link FileSystemStore}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.Block -->
- <!-- start interface org.apache.hadoop.fs.s3.FileSystemStore -->
- <interface name="FileSystemStore" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="storeINode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="inode" type="org.apache.hadoop.fs.s3.INode"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="storeBlock"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="block" type="org.apache.hadoop.fs.s3.Block"/>
- <param name="file" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="inodeExists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="blockExists" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="blockId" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="retrieveINode" return="org.apache.hadoop.fs.s3.INode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="retrieveBlock" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="block" type="org.apache.hadoop.fs.s3.Block"/>
- <param name="byteRangeStart" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteINode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteBlock"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="block" type="org.apache.hadoop.fs.s3.Block"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listSubPaths" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listDeepSubPaths" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="purge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete everything. Used for testing.
- @throws IOException]]>
- </doc>
- </method>
- <method name="dump"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Diagnostic method to dump all INodes to the console.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A facility for storing and retrieving {@link INode}s and {@link Block}s.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.fs.s3.FileSystemStore -->
- <!-- start class org.apache.hadoop.fs.s3.INode -->
- <class name="INode" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="INode" type="org.apache.hadoop.fs.s3.INode.FileType, org.apache.hadoop.fs.s3.Block[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getBlocks" return="org.apache.hadoop.fs.s3.Block[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileType" return="org.apache.hadoop.fs.s3.INode.FileType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isDirectory" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSerializedLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="serialize" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deserialize" return="org.apache.hadoop.fs.s3.INode"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="FILE_TYPES" type="org.apache.hadoop.fs.s3.INode.FileType[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DIRECTORY_INODE" type="org.apache.hadoop.fs.s3.INode"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Holds file metadata including type (regular file, or directory),
- and the list of blocks that are pointers to the data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.INode -->
- <!-- start class org.apache.hadoop.fs.s3.MigrationTool -->
- <class name="MigrationTool" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="MigrationTool"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[<p>
- This class is a tool for migrating data from an older to a newer version
- of an S3 filesystem.
- </p>
- <p>
- All files in the filesystem are migrated by re-writing the block metadata
- - no datafiles are touched.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.MigrationTool -->
- <!-- start class org.apache.hadoop.fs.s3.S3Credentials -->
- <class name="S3Credentials" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="S3Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[@throws IllegalArgumentException if credentials for S3 cannot be
- determined.]]>
- </doc>
- </method>
- <method name="getAccessKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSecretAccessKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>
- Extracts AWS credentials from the filesystem URI or configuration.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.S3Credentials -->
- <!-- start class org.apache.hadoop.fs.s3.S3Exception -->
- <class name="S3Exception" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="S3Exception" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Thrown if there is a problem communicating with Amazon S3.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.S3Exception -->
- <!-- start class org.apache.hadoop.fs.s3.S3FileSystem -->
- <class name="S3FileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="S3FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="S3FileSystem" type="org.apache.hadoop.fs.s3.FileSystemStore"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@param permission Currently ignored.]]>
- </doc>
- </method>
- <method name="isFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This optional operation is not yet supported.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@param permission Currently ignored.]]>
- </doc>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="recursive" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[FileStatus for S3 file systems.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- A block-based {@link FileSystem} backed by
- <a href="http://aws.amazon.com/s3">Amazon S3</a>.
- </p>
- @see NativeS3FileSystem]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.S3FileSystem -->
- <!-- start class org.apache.hadoop.fs.s3.S3FileSystemException -->
- <class name="S3FileSystemException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="S3FileSystemException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Thrown when there is a fatal exception while using {@link S3FileSystem}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.S3FileSystemException -->
- <!-- start class org.apache.hadoop.fs.s3.VersionMismatchException -->
- <class name="VersionMismatchException" extends="org.apache.hadoop.fs.s3.S3FileSystemException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VersionMismatchException" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Thrown when Hadoop cannot read the version of the data stored
- in {@link S3FileSystem}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3.VersionMismatchException -->
- </package>
- <package name="org.apache.hadoop.fs.s3native">
- <!-- start class org.apache.hadoop.fs.s3native.NativeS3FileSystem -->
- <class name="NativeS3FileSystem" extends="org.apache.hadoop.fs.FileSystem"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NativeS3FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="NativeS3FileSystem" type="org.apache.hadoop.fs.s3native.NativeFileSystemStore"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This optional operation is not yet supported.]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <param name="overwrite" type="boolean"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="delete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="recurse" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- If <code>f</code> is a file, this method will make a single call to S3.
- If <code>f</code> is a directory, this method will make a maximum of
- (<i>n</i> / 1000) + 2 calls to S3, where <i>n</i> is the total number of
- files and directories contained directly in <code>f</code>.
- </p>]]>
- </doc>
- </method>
- <method name="mkdirs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rename" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="org.apache.hadoop.fs.Path"/>
- <param name="dst" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the working directory to the given directory.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- A {@link FileSystem} for reading and writing files stored on
- <a href="http://aws.amazon.com/s3">Amazon S3</a>.
- Unlike {@link org.apache.hadoop.fs.s3.S3FileSystem} this implementation
- stores files on S3 in their
- native form so they can be read by other S3 tools.
- A note about directories. S3 of course has no "native" support for them.
- The idiom we choose then is: for any directory created by this class,
- we use an empty object "#{dirpath}_$folder$" as a marker.
- Further, to interoperate with other S3 tools, we also accept the following:
- - an object "#{dirpath}/' denoting a directory marker
- - if there exists any objects with the prefix "#{dirpath}/", then the
- directory is said to exist
- - if both a file with the name of a directory and a marker for that
- directory exists, then the *file masks the directory*, and the directory
- is never returned.
- </p>
- @see org.apache.hadoop.fs.s3.S3FileSystem]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.s3native.NativeS3FileSystem -->
- </package>
- <package name="org.apache.hadoop.fs.shell">
- <!-- start class org.apache.hadoop.fs.shell.Command -->
- <class name="Command" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Command" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor]]>
- </doc>
- </constructor>
- <method name="getCommandName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the command's name excluding the leading character -]]>
- </doc>
- </method>
- <method name="run"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Execute the command on the input path
-
- @param path the input path
- @throws IOException if any error occurs]]>
- </doc>
- </method>
- <method name="runAll" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[For each source path, execute the command
-
- @return 0 if it runs successfully; -1 if it fails]]>
- </doc>
- </method>
- <field name="args" type="java.lang.String[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An abstract class for the execution of a file system command]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.shell.Command -->
- <!-- start class org.apache.hadoop.fs.shell.CommandFormat -->
- <class name="CommandFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CommandFormat" type="java.lang.String, int, int, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructor]]>
- </doc>
- </constructor>
- <method name="parse" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <param name="pos" type="int"/>
- <doc>
- <![CDATA[Parse parameters starting from the given position
-
- @param args an array of input arguments
- @param pos the position at which starts to parse
- @return a list of parameters]]>
- </doc>
- </method>
- <method name="getOpt" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="option" type="java.lang.String"/>
- <doc>
- <![CDATA[Return if the option is set or not
-
- @param option String representation of an option
- @return true is the option is set; false otherwise]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Parse the args of a command and check the format of args.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.shell.CommandFormat -->
- <!-- start class org.apache.hadoop.fs.shell.Count -->
- <class name="Count" extends="org.apache.hadoop.fs.shell.Command"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Count" type="java.lang.String[], int, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
-
- @param cmd the count command
- @param pos the starting index of the arguments]]>
- </doc>
- </constructor>
- <method name="matches" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.lang.String"/>
- <doc>
- <![CDATA[Check if a command is the count command
-
- @param cmd A string representation of a command starting with "-"
- @return true if this is a count command; false otherwise]]>
- </doc>
- </method>
- <method name="getCommandName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DESCRIPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Count the number of directories, files, bytes, quota, and remaining quota.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.fs.shell.Count -->
- </package>
- <package name="org.apache.hadoop.http">
- <!-- start class org.apache.hadoop.http.AdminAuthorizedServlet -->
- <class name="AdminAuthorizedServlet" extends="org.mortbay.jetty.servlet.DefaultServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AdminAuthorizedServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[General servlet which is admin-authorized.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.AdminAuthorizedServlet -->
- <!-- start interface org.apache.hadoop.http.FilterContainer -->
- <interface name="FilterContainer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="addFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="classname" type="java.lang.String"/>
- <param name="parameters" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a filter to the container.
- @param name Filter name
- @param classname Filter class name
- @param parameters a map from parameter names to initial values]]>
- </doc>
- </method>
- <method name="addGlobalFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="classname" type="java.lang.String"/>
- <param name="parameters" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a global filter to the container.
- @param name filter name
- @param classname filter class name
- @param parameters a map from parameter names to initial values]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A container class for javax.servlet.Filter.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.http.FilterContainer -->
- <!-- start class org.apache.hadoop.http.FilterInitializer -->
- <class name="FilterInitializer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FilterInitializer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initFilter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="container" type="org.apache.hadoop.http.FilterContainer"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Initialize a Filter to a FilterContainer.
- @param container The filter container
- @param conf Configuration for run-time parameters]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initialize a javax.servlet.Filter.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.FilterInitializer -->
- <!-- start class org.apache.hadoop.http.HtmlQuoting -->
- <class name="HtmlQuoting" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HtmlQuoting"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="needsQuoting" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Does the given string need to be quoted?
- @param data the string to check
- @param off the starting position
- @param len the number of bytes to check
- @return does the string contain any of the active html characters?]]>
- </doc>
- </method>
- <method name="needsQuoting" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Does the given string need to be quoted?
- @param str the string to check
- @return does the string contain any of the active html characters?]]>
- </doc>
- </method>
- <method name="quoteHtmlChars"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="output" type="java.io.OutputStream"/>
- <param name="buffer" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Quote all of the active HTML characters in the given string as they
- are added to the buffer.
- @param output the stream to write the output to
- @param buffer the byte array to take the characters from
- @param off the index of the first byte to quote
- @param len the number of bytes to quote]]>
- </doc>
- </method>
- <method name="quoteHtmlChars" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="java.lang.String"/>
- <doc>
- <![CDATA[Quote the given item to make it html-safe.
- @param item the string to quote
- @return the quoted string]]>
- </doc>
- </method>
- <method name="quoteOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an output stream that quotes all of the output.
- @param out the stream to write the quoted output to
- @return a new stream that the application show write to
- @throws IOException if the underlying output fails]]>
- </doc>
- </method>
- <method name="unquoteHtmlChars" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="java.lang.String"/>
- <doc>
- <![CDATA[Remove HTML quoting from a string.
- @param item the string to unquote
- @return the unquoted string]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[This class is responsible for quoting HTML characters.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.HtmlQuoting -->
- <!-- start class org.apache.hadoop.http.HttpServer -->
- <class name="HttpServer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.http.FilterContainer"/>
- <constructor name="HttpServer" type="java.lang.String, java.lang.String, int, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as this(name, bindAddress, port, findPort, null);]]>
- </doc>
- </constructor>
- <constructor name="HttpServer" type="java.lang.String, java.lang.String, int, boolean, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="HttpServer" type="java.lang.String, java.lang.String, int, boolean, org.apache.hadoop.conf.Configuration, org.mortbay.jetty.Connector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="HttpServer" type="java.lang.String, java.lang.String, int, boolean, org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.authorize.AccessControlList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a status server on the given port.
- The jsp scripts are taken from src/webapps/<name>.
- @param name The name of the server
- @param port The port to use on the server
- @param findPort whether the server should start at the given port and
- increment by 1 until it finds a free port.
- @param conf Configuration
- @param adminsAcl {@link AccessControlList} of the admins]]>
- </doc>
- </constructor>
- <constructor name="HttpServer" type="java.lang.String, java.lang.String, int, boolean, org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.authorize.AccessControlList, org.mortbay.jetty.Connector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="createBaseListener" return="org.mortbay.jetty.Connector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a required listener for the Jetty instance listening on the port
- provided. This wrapper and all subclasses must create at least one
- listener.]]>
- </doc>
- </method>
- <method name="createDefaultChannelConnector" return="org.mortbay.jetty.Connector"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addDefaultApps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="parent" type="org.mortbay.jetty.handler.ContextHandlerCollection"/>
- <param name="appDir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add default apps.
- @param appDir The application directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="addDefaultServlets"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Add default servlets.]]>
- </doc>
- </method>
- <method name="addContext"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ctxt" type="org.mortbay.jetty.servlet.Context"/>
- <param name="isFiltered" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="addContext"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pathSpec" type="java.lang.String"/>
- <param name="dir" type="java.lang.String"/>
- <param name="isFiltered" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a context
- @param pathSpec The path spec for the context
- @param dir The directory containing the context
- @param isFiltered if true, the servlet is added to the filter path mapping
- @throws IOException]]>
- </doc>
- </method>
- <method name="setAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Set a value in the webapp context. These values are available to the jsp
- pages as "application.getAttribute(name)".
- @param name The name of the attribute
- @param value The value of the attribute]]>
- </doc>
- </method>
- <method name="setAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.mortbay.jetty.servlet.Context"/>
- <param name="name" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Set a value in the webapp context. These values are available to the jsp
- pages as "application.getAttribute(name)".
- @param context Context to add attribute
- @param name The name of the attribute
- @param value The value of the attribute]]>
- </doc>
- </method>
- <method name="addJerseyResourcePackage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="packageName" type="java.lang.String"/>
- <param name="pathSpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a Jersey resource package.
- @param packageName The Java package name containing the Jersey resource.
- @param pathSpec The path spec for the servlet]]>
- </doc>
- </method>
- <method name="addServlet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="pathSpec" type="java.lang.String"/>
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a servlet in the server.
- @param name The name of the servlet (can be passed as null)
- @param pathSpec The path spec for the servlet
- @param clazz The servlet class]]>
- </doc>
- </method>
- <method name="addInternalServlet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="this is a temporary method">
- <param name="name" type="java.lang.String"/>
- <param name="pathSpec" type="java.lang.String"/>
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add an internal servlet in the server.
- @param name The name of the servlet (can be passed as null)
- @param pathSpec The path spec for the servlet
- @param clazz The servlet class
- @deprecated this is a temporary method]]>
- </doc>
- </method>
- <method name="addInternalServlet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="pathSpec" type="java.lang.String"/>
- <param name="clazz" type="java.lang.Class"/>
- <param name="requireAuth" type="boolean"/>
- <param name="useKsslForAuth" type="boolean"/>
- <doc>
- <![CDATA[Add an internal servlet in the server, specifying whether or not to
- protect with Kerberos authentication.
- Note: This method is to be used for adding servlets that facilitate
- internal communication and not for user facing functionality. For
- servlets added using this method, filters (except internal Kerberos
- filters) are not enabled.
-
- @param name The name of the servlet (can be passed as null)
- @param pathSpec The path spec for the servlet
- @param clazz The servlet class
- @param requireAuth Require Kerberos authenticate to access servlet
- @param useKsslForAuth true to use KSSL for auth, false to use SPNEGO]]>
- </doc>
- </method>
- <method name="addFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="classname" type="java.lang.String"/>
- <param name="parameters" type="java.util.Map"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="addGlobalFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="classname" type="java.lang.String"/>
- <param name="parameters" type="java.util.Map"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="defineFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="ctx" type="org.mortbay.jetty.servlet.Context"/>
- <param name="name" type="java.lang.String"/>
- <param name="classname" type="java.lang.String"/>
- <param name="parameters" type="java.util.Map"/>
- <param name="urls" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Define a filter for a context and set up default url mappings.]]>
- </doc>
- </method>
- <method name="addFilterPathMapping"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pathSpec" type="java.lang.String"/>
- <param name="webAppCtx" type="org.mortbay.jetty.servlet.Context"/>
- <doc>
- <![CDATA[Add the path spec to the filter path mapping.
- @param pathSpec The path spec
- @param webAppCtx The WebApplicationContext to add to]]>
- </doc>
- </method>
- <method name="getAttribute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value in the webapp context.
- @param name The name of the attribute
- @return The value of the attribute]]>
- </doc>
- </method>
- <method name="getWebAppsPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the pathname to the webapps files.
- @return the pathname as a URL
- @throws IOException if 'webapps' directory cannot be found on CLASSPATH.]]>
- </doc>
- </method>
- <method name="getPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the port that the server is on
- @return the port]]>
- </doc>
- </method>
- <method name="setThreads"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="min" type="int"/>
- <param name="max" type="int"/>
- <doc>
- <![CDATA[Set the min, max number of worker threads (simultaneous connections).]]>
- </doc>
- </method>
- <method name="addSslListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #addSslListener(InetSocketAddress, Configuration, boolean)}">
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="keystore" type="java.lang.String"/>
- <param name="storPass" type="java.lang.String"/>
- <param name="keyPass" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Configure an ssl listener on the server.
- @param addr address to listen on
- @param keystore location of the keystore
- @param storPass password for the keystore
- @param keyPass password for the key
- @deprecated Use {@link #addSslListener(InetSocketAddress, Configuration, boolean)}]]>
- </doc>
- </method>
- <method name="addSslListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="sslConf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="needClientAuth" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Configure an ssl listener on the server.
- @param addr address to listen on
- @param sslConf conf to retrieve ssl options
- @param needClientAuth whether client authentication is required]]>
- </doc>
- </method>
- <method name="addSslListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="sslConf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="needCertsAuth" type="boolean"/>
- <param name="needKrbAuth" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Configure an ssl listener on the server.
- @param addr address to listen on
- @param sslConf conf to retrieve ssl options
- @param needCertsAuth whether x509 certificate authentication is required
- @param needKrbAuth whether to allow kerberos auth]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Start the server. Does not wait for the server to start.]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[stop the server]]>
- </doc>
- </method>
- <method name="join"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="isInstrumentationAccessAllowed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="servletContext" type="javax.servlet.ServletContext"/>
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Checks the user has privileges to access to instrumentation servlets.
- <p/>
- If <code>hadoop.security.instrumentation.requires.admin</code> is set to
- FALSE (default value) it returns always returns TRUE.
- <p/>
- If <code>hadoop.security.instrumentation.requires.admin</code> is set to
- TRUE it will check that if the current user is in the admin ACLS. If the
- user is in the admin ACLs it returns TRUE, otherwise it returns FALSE.
- @param servletContext the servlet context.
- @param request the servlet request.
- @param response the servlet response.
- @return TRUE/FALSE based on the logic decribed above.]]>
- </doc>
- </method>
- <method name="hasAdministratorAccess" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="servletContext" type="javax.servlet.ServletContext"/>
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Does the user sending the HttpServletRequest has the administrator ACLs? If
- it isn't the case, response will be modified to send an error to the user.
-
- @param servletContext
- @param request
- @param response
- @return true if admin-authorized, false otherwise
- @throws IOException]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_CONTEXT_ATTRIBUTE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SPNEGO_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KRB5_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="webServer" type="org.mortbay.jetty.Server"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="listener" type="org.mortbay.jetty.Connector"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="webAppContext" type="org.mortbay.jetty.webapp.WebAppContext"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="findPort" type="boolean"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="defaultContexts" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="filterNames" type="java.util.List"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Create a Jetty embedded server to answer http requests. The primary goal
- is to serve up status information for the server.
- There are three contexts:
- "/logs/" -> points to the log directory
- "/static/" -> points to common static files (src/webapps/static)
- "/" -> the jsp server code from (src/webapps/<name>)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.HttpServer -->
- <!-- start class org.apache.hadoop.http.HttpServer.QuotingInputFilter -->
- <class name="HttpServer.QuotingInputFilter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="HttpServer.QuotingInputFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.ServletRequest"/>
- <param name="response" type="javax.servlet.ServletResponse"/>
- <param name="chain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <doc>
- <![CDATA[A Servlet input filter that quotes all HTML active characters in the
- parameter names and values. The goal is to quote the characters to make
- all of the servlets resistant to cross-site scripting attacks.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.HttpServer.QuotingInputFilter -->
- <!-- start class org.apache.hadoop.http.HttpServer.QuotingInputFilter.RequestQuoter -->
- <class name="HttpServer.QuotingInputFilter.RequestQuoter" extends="javax.servlet.http.HttpServletRequestWrapper"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HttpServer.QuotingInputFilter.RequestQuoter" type="javax.servlet.http.HttpServletRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getParameterNames" return="java.util.Enumeration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the set of parameter names, quoting each name.]]>
- </doc>
- </method>
- <method name="getParameter" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Unquote the name and quote the value.]]>
- </doc>
- </method>
- <method name="getParameterValues" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getParameterMap" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRequestURL" return="java.lang.StringBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Quote the url so that users specifying the HOST HTTP header
- can't inject attacks.]]>
- </doc>
- </method>
- <method name="getServerName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Quote the server name so that users specifying the HOST HTTP header
- can't inject attacks.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.http.HttpServer.QuotingInputFilter.RequestQuoter -->
- <!-- start class org.apache.hadoop.http.HttpServer.StackServlet -->
- <class name="HttpServer.StackServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HttpServer.StackServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A very simple servlet to serve up a text representation of the current
- stack traces. It both returns the stacks to the caller and logs them.
- Currently the stack traces are done sequentially rather than exactly the
- same data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.HttpServer.StackServlet -->
- </package>
- <package name="org.apache.hadoop.http.lib">
- <!-- start class org.apache.hadoop.http.lib.StaticUserWebFilter -->
- <class name="StaticUserWebFilter" extends="org.apache.hadoop.http.FilterInitializer"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StaticUserWebFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="container" type="org.apache.hadoop.http.FilterContainer"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[Provides a servlet filter that pretends to authenticate a fake user (Dr.Who)
- so that the web UI is usable for a secure cluster without authentication.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.http.lib.StaticUserWebFilter -->
- <!-- start class org.apache.hadoop.http.lib.StaticUserWebFilter.StaticUserFilter -->
- <class name="StaticUserWebFilter.StaticUserFilter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="StaticUserWebFilter.StaticUserFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.ServletRequest"/>
- <param name="response" type="javax.servlet.ServletResponse"/>
- <param name="chain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.http.lib.StaticUserWebFilter.StaticUserFilter -->
- </package>
- <package name="org.apache.hadoop.io">
- <!-- start class org.apache.hadoop.io.AbstractMapWritable -->
- <class name="AbstractMapWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="AbstractMapWritable"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructor.]]>
- </doc>
- </constructor>
- <method name="addToMap"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a Class to the maps if it is not already present.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="id" type="byte"/>
- <doc>
- <![CDATA[@return the Class class for the specified id]]>
- </doc>
- </method>
- <method name="getId" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[@return the id for the specified Class]]>
- </doc>
- </method>
- <method name="copy"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[Used by child copy constructors.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the conf]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[@param conf the conf to set]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Abstract base class for MapWritable and SortedMapWritable
-
- Unlike org.apache.nutch.crawl.MapWritable, this class allows creation of
- MapWritable<Writable, MapWritable> so the CLASS_TO_ID and ID_TO_CLASS
- maps travel with the class instead of being static.
-
- Class ids range from 1 to 127 so there can be at most 127 distinct classes
- in any specific map instance.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.AbstractMapWritable -->
- <!-- start class org.apache.hadoop.io.ArrayFile -->
- <class name="ArrayFile" extends="org.apache.hadoop.io.MapFile"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ArrayFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A dense file-based mapping from integers to values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayFile -->
- <!-- start class org.apache.hadoop.io.ArrayFile.Reader -->
- <class name="ArrayFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ArrayFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct an array reader for the named file.]]>
- </doc>
- </constructor>
- <method name="seek"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Positions the reader before its <code>n</code>th value.]]>
- </doc>
- </method>
- <method name="next" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read and return the next value in the file.]]>
- </doc>
- </method>
- <method name="key" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the key associated with the most recent call to {@link
- #seek(long)}, {@link #next(Writable)}, or {@link
- #get(long,Writable)}.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the <code>n</code>th value in the file.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provide access to an existing array file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayFile.Reader -->
- <!-- start class org.apache.hadoop.io.ArrayFile.Writer -->
- <class name="ArrayFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ArrayFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named file for values of the named class.]]>
- </doc>
- </constructor>
- <constructor name="ArrayFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named file for values of the named class.]]>
- </doc>
- </constructor>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append a value to the file.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Write a new array file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayFile.Writer -->
- <!-- start class org.apache.hadoop.io.ArrayWritable -->
- <class name="ArrayWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ArrayWritable" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ArrayWritable" type="java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toArray" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="values" type="org.apache.hadoop.io.Writable[]"/>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A Writable for arrays containing instances of a class. The elements of this
- writable must all be instances of the same class. If this writable will be
- the input for a Reducer, you will need to create a subclass that sets the
- value to be of the proper type.
- For example:
- <code>
- public class IntArrayWritable extends ArrayWritable {
- public IntArrayWritable() {
- super(IntWritable.class);
- }
- }
- </code>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ArrayWritable -->
- <!-- start class org.apache.hadoop.io.BinaryComparable -->
- <class name="BinaryComparable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="BinaryComparable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLength" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return n st bytes 0..n-1 from {#getBytes()} are valid.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return representative byte array for this instance.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.BinaryComparable"/>
- <doc>
- <![CDATA[Compare bytes from {#getBytes()}.
- @see org.apache.hadoop.io.WritableComparator#compareBytes(byte[],int,int,byte[],int,int)]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Compare bytes from {#getBytes()} to those provided.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return true if bytes from {#getBytes()} match.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a hash of the bytes returned from {#getBytes()}.
- @see org.apache.hadoop.io.WritableComparator#hashBytes(byte[],int)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface supported by {@link org.apache.hadoop.io.WritableComparable}
- types supporting ordering/permutation by a representative set of bytes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BinaryComparable -->
- <!-- start class org.apache.hadoop.io.BloomMapFile -->
- <class name="BloomMapFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomMapFile"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="BLOOM_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HASH_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class extends {@link MapFile} and provides very much the same
- functionality. However, it uses dynamic Bloom filters to provide
- quick membership test for keys, and it offers a fast version of
- {@link Reader#get(WritableComparable, Writable)} operation, especially in
- case of sparsely populated MapFile-s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BloomMapFile -->
- <!-- start class org.apache.hadoop.io.BloomMapFile.Reader -->
- <class name="BloomMapFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="probablyHasKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Checks if this MapFile has the indicated key. The membership test is
- performed using a Bloom filter, so the result has always non-zero
- probability of false positives.
- @param key key to check
- @return false iff key doesn't exist, true if key probably exists.
- @throws IOException]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fast version of the
- {@link MapFile.Reader#get(WritableComparable, Writable)} method. First
- it checks the Bloom filter for the existence of the key, and only if
- present it performs the real get operation. This yields significant
- performance improvements for get operations on sparsely populated files.]]>
- </doc>
- </method>
- <method name="getBloomFilter" return="org.apache.hadoop.util.bloom.Filter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the Bloom filter used by this instance of the Reader.
- @return a Bloom filter (see {@link Filter})]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.BloomMapFile.Reader -->
- <!-- start class org.apache.hadoop.io.BloomMapFile.Writer -->
- <class name="BloomMapFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.BloomMapFile.Writer -->
- <!-- start class org.apache.hadoop.io.BooleanWritable -->
- <class name="BooleanWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="BooleanWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BooleanWritable" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set the value of the BooleanWritable]]>
- </doc>
- </method>
- <method name="get" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the value of the BooleanWritable]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for booleans.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BooleanWritable -->
- <!-- start class org.apache.hadoop.io.BooleanWritable.Comparator -->
- <class name="BooleanWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BooleanWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for BooleanWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BooleanWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.BytesWritable -->
- <class name="BytesWritable" extends="org.apache.hadoop.io.BinaryComparable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="BytesWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a zero-size sequence.]]>
- </doc>
- </constructor>
- <constructor name="BytesWritable" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a BytesWritable using the byte array as the initial value.
- @param bytes This array becomes the backing storage for the object.]]>
- </doc>
- </constructor>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data from the BytesWritable.
- @return The data is only valid between 0 and getLength() - 1.]]>
- </doc>
- </method>
- <method name="get" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getBytes()} instead.">
- <doc>
- <![CDATA[Get the data from the BytesWritable.
- @deprecated Use {@link #getBytes()} instead.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current size of the buffer.]]>
- </doc>
- </method>
- <method name="getSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getLength()} instead.">
- <doc>
- <![CDATA[Get the current size of the buffer.
- @deprecated Use {@link #getLength()} instead.]]>
- </doc>
- </method>
- <method name="setSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="int"/>
- <doc>
- <![CDATA[Change the size of the buffer. The values in the old range are preserved
- and any new values are undefined. The capacity is changed if it is
- necessary.
- @param size The new number of bytes]]>
- </doc>
- </method>
- <method name="getCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the capacity, which is the maximum size that could handled without
- resizing the backing storage.
- @return The number of bytes]]>
- </doc>
- </method>
- <method name="setCapacity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="new_cap" type="int"/>
- <doc>
- <![CDATA[Change the capacity of the backing storage.
- The data is preserved.
- @param new_cap The new capacity in bytes.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newData" type="org.apache.hadoop.io.BytesWritable"/>
- <doc>
- <![CDATA[Set the BytesWritable to the contents of the given newData.
- @param newData the value to set this BytesWritable to.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newData" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Set the value to a copy of the given byte range
- @param newData the new values to copy in
- @param offset the offset in newData to start at
- @param length the number of bytes to copy]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="right_obj" type="java.lang.Object"/>
- <doc>
- <![CDATA[Are the two byte sequences equal?]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate the stream of bytes as hex pairs separated by ' '.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A byte sequence that is usable as a key or value.
- It is resizable and distinguishes between the size of the seqeunce and
- the current capacity. The hash function is the front of the md5 of the
- buffer. The sort order is the same as memcmp.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BytesWritable -->
- <!-- start class org.apache.hadoop.io.BytesWritable.Comparator -->
- <class name="BytesWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BytesWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Compare the buffers in serialized form.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for BytesWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.BytesWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.ByteWritable -->
- <class name="ByteWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="ByteWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ByteWritable" type="byte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Set the value of this ByteWritable.]]>
- </doc>
- </method>
- <method name="get" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this ByteWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a ByteWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two ByteWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for a single byte.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ByteWritable -->
- <!-- start class org.apache.hadoop.io.ByteWritable.Comparator -->
- <class name="ByteWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ByteWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for ByteWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ByteWritable.Comparator -->
- <!-- start interface org.apache.hadoop.io.Closeable -->
- <interface name="Closeable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="use java.io.Closeable">
- <implements name="java.io.Closeable"/>
- <doc>
- <![CDATA[@deprecated use java.io.Closeable]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Closeable -->
- <!-- start class org.apache.hadoop.io.CompressedWritable -->
- <class name="CompressedWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="CompressedWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="ensureInflated"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Must be called by all methods which access fields to ensure that the data
- has been uncompressed.]]>
- </doc>
- </method>
- <method name="readFieldsCompressed"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Subclasses implement this instead of {@link #readFields(DataInput)}.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressed"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Subclasses implement this instead of {@link #write(DataOutput)}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A base-class for Writables which store themselves compressed and lazily
- inflate on field access. This is useful for large objects whose fields are
- not be altered during a map or reduce operation: leaving the field data
- compressed makes copying the instance from one file to another much
- faster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.CompressedWritable -->
- <!-- start class org.apache.hadoop.io.DataInputBuffer -->
- <class name="DataInputBuffer" extends="java.io.DataInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DataInputBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new empty buffer.]]>
- </doc>
- </constructor>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="byte[]"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Resets the data that the buffer reads.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Resets the data that the buffer reads.]]>
- </doc>
- </method>
- <method name="getData" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPosition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current position in the input.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the length of the input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A reusable {@link DataInput} implementation that reads from an in-memory
- buffer.
- <p>This saves memory over creating a new DataInputStream and
- ByteArrayInputStream each time data is read.
- <p>Typical usage is something like the following:<pre>
- DataInputBuffer buffer = new DataInputBuffer();
- while (... loop condition ...) {
- byte[] data = ... get data ...;
- int dataLength = ... get data length ...;
- buffer.reset(data, dataLength);
- ... read buffer using DataInput methods ...
- }
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DataInputBuffer -->
- <!-- start class org.apache.hadoop.io.DataOutputBuffer -->
- <class name="DataOutputBuffer" extends="java.io.DataOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DataOutputBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new empty buffer.]]>
- </doc>
- </constructor>
- <constructor name="DataOutputBuffer" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getData" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current contents of the buffer.
- Data is only valid to {@link #getLength()}.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the length of the valid data currently in the buffer.]]>
- </doc>
- </method>
- <method name="reset" return="org.apache.hadoop.io.DataOutputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets the buffer to empty.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes bytes from a DataInput directly into the buffer.]]>
- </doc>
- </method>
- <method name="writeTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write to a file stream]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A reusable {@link DataOutput} implementation that writes to an in-memory
- buffer.
- <p>This saves memory over creating a new DataOutputStream and
- ByteArrayOutputStream each time data is written.
- <p>Typical usage is something like the following:<pre>
- DataOutputBuffer buffer = new DataOutputBuffer();
- while (... loop condition ...) {
- buffer.reset();
- ... write buffer using DataOutput methods ...
- byte[] data = buffer.getData();
- int dataLength = buffer.getLength();
- ... write data to its ultimate destination ...
- }
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DataOutputBuffer -->
- <!-- start class org.apache.hadoop.io.DefaultStringifier -->
- <class name="DefaultStringifier" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Stringifier"/>
- <constructor name="DefaultStringifier" type="org.apache.hadoop.conf.Configuration, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="fromString" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="store"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="item" type="java.lang.Object"/>
- <param name="keyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores the item in the configuration with the given keyName.
-
- @param <K> the class of the item
- @param conf the configuration to store
- @param item the object to be stored
- @param keyName the name of the key to use
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="load" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keyName" type="java.lang.String"/>
- <param name="itemClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the object from the configuration.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param keyName the name of the key to use
- @param itemClass the class of the item
- @return restored object
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="storeArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="items" type="java.lang.Object[]"/>
- <param name="keyName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores the array of items in the configuration with the given keyName.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param items the objects to be stored
- @param keyName the name of the key to use
- @throws IndexOutOfBoundsException if the items array is empty
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <method name="loadArray" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keyName" type="java.lang.String"/>
- <param name="itemClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the array of objects from the configuration.
-
- @param <K> the class of the item
- @param conf the configuration to use
- @param keyName the name of the key to use
- @param itemClass the class of the item
- @return restored object
- @throws IOException : forwards Exceptions from the underlying
- {@link Serialization} classes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[DefaultStringifier is the default implementation of the {@link Stringifier}
- interface which stringifies the objects using base64 encoding of the
- serialized version of the objects. The {@link Serializer} and
- {@link Deserializer} are obtained from the {@link SerializationFactory}.
- <br>
- DefaultStringifier offers convenience methods to store/load objects to/from
- the configuration.
-
- @param <T> the class of the objects to stringify]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DefaultStringifier -->
- <!-- start class org.apache.hadoop.io.DoubleWritable -->
- <class name="DoubleWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="DoubleWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="DoubleWritable" type="double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="double"/>
- </method>
- <method name="get" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a DoubleWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Writable for Double values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DoubleWritable -->
- <!-- start class org.apache.hadoop.io.DoubleWritable.Comparator -->
- <class name="DoubleWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DoubleWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for DoubleWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.DoubleWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.FloatWritable -->
- <class name="FloatWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="FloatWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FloatWritable" type="float"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Set the value of this FloatWritable.]]>
- </doc>
- </method>
- <method name="get" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this FloatWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a FloatWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two FloatWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for floats.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.FloatWritable -->
- <!-- start class org.apache.hadoop.io.FloatWritable.Comparator -->
- <class name="FloatWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FloatWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for FloatWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.FloatWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.GenericWritable -->
- <class name="GenericWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="GenericWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[Set the instance that is wrapped.
-
- @param obj]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the wrapped instance.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTypes" return="java.lang.Class[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all classes that may be wrapped. Subclasses should implement this
- to return a constant array of classes.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[A wrapper for Writable instances.
- <p>
- When two sequence files, which have same Key type but different Value
- types, are mapped out to reduce, multiple Value types is not allowed.
- In this case, this class can help you wrap instances with different types.
- </p>
-
- <p>
- Compared with <code>ObjectWritable</code>, this class is much more effective,
- because <code>ObjectWritable</code> will append the class declaration as a String
- into the output file in every Key-Value pair.
- </p>
-
- <p>
- Generic Writable implements {@link Configurable} interface, so that it will be
- configured by the framework. The configuration is passed to the wrapped objects
- implementing {@link Configurable} interface <i>before deserialization</i>.
- </p>
-
- how to use it: <br>
- 1. Write your own class, such as GenericObject, which extends GenericWritable.<br>
- 2. Implements the abstract method <code>getTypes()</code>, defines
- the classes which will be wrapped in GenericObject in application.
- Attention: this classes defined in <code>getTypes()</code> method, must
- implement <code>Writable</code> interface.
- <br><br>
-
- The code looks like this:
- <blockquote><pre>
- public class GenericObject extends GenericWritable {
-
- private static Class[] CLASSES = {
- ClassType1.class,
- ClassType2.class,
- ClassType3.class,
- };
- protected Class[] getTypes() {
- return CLASSES;
- }
- }
- </pre></blockquote>
-
- @since Nov 8, 2006]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.GenericWritable -->
- <!-- start class org.apache.hadoop.io.InputBuffer -->
- <class name="InputBuffer" extends="java.io.FilterInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InputBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new empty buffer.]]>
- </doc>
- </constructor>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="byte[]"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Resets the data that the buffer reads.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Resets the data that the buffer reads.]]>
- </doc>
- </method>
- <method name="getPosition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current position in the input.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the length of the input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A reusable {@link InputStream} implementation that reads from an in-memory
- buffer.
- <p>This saves memory over creating a new InputStream and
- ByteArrayInputStream each time data is read.
- <p>Typical usage is something like the following:<pre>
- InputBuffer buffer = new InputBuffer();
- while (... loop condition ...) {
- byte[] data = ... get data ...;
- int dataLength = ... get data length ...;
- buffer.reset(data, dataLength);
- ... read buffer using InputStream methods ...
- }
- </pre>
- @see DataInputBuffer
- @see DataOutput]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.InputBuffer -->
- <!-- start class org.apache.hadoop.io.IntWritable -->
- <class name="IntWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="IntWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="IntWritable" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of this IntWritable.]]>
- </doc>
- </method>
- <method name="get" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this IntWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a IntWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two IntWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for ints.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IntWritable -->
- <!-- start class org.apache.hadoop.io.IntWritable.Comparator -->
- <class name="IntWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IntWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for IntWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IntWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.IOUtils -->
- <class name="IOUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IOUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="buffSize" type="int"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param buffSize the size of the buffer
- @param close whether or not close the InputStream and
- OutputStream at the end. The streams are closed in the finally clause.]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="buffSize" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
-
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param buffSize the size of the buffer]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another. <strong>closes the input and output streams
- at the end</strong>.
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param conf the Configuration object]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies from one stream to another.
- @param in InputStrem to read from
- @param out OutputStream to write to
- @param conf the Configuration object
- @param close whether or not close the InputStream and
- OutputStream at the end. The streams are closed in the finally clause.]]>
- </doc>
- </method>
- <method name="copyBytes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="out" type="java.io.OutputStream"/>
- <param name="length" type="long"/>
- <param name="bufferSize" type="int"/>
- <param name="close" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copies the specified length of bytes from in to out.
- @param in InputStream to read from
- @param out OutputStream to write to
- @param length number of bytes to copy
- @param bufferSize the size of the buffer
- @param close whether to close the streams
- @throws IOException if bytes can not be read or written]]>
- </doc>
- </method>
- <method name="wrappedReadForCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="is" type="java.io.InputStream"/>
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Utility wrapper for reading from {@link InputStream}. It catches any errors
- thrown by the underlying stream (either IO or decompression-related), and
- re-throws as an IOException.
-
- @param is - InputStream to be read from
- @param buf - buffer the data is read into
- @param off - offset within buf
- @param len - amount of data to be read
- @return number of bytes read]]>
- </doc>
- </method>
- <method name="readFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads len bytes in a loop.
- @param in The InputStream to read from
- @param buf The buffer to fill
- @param off offset from the buffer
- @param len the length of bytes to read
- @throws IOException if it could not read requested number of bytes
- for any reason (including EOF)]]>
- </doc>
- </method>
- <method name="readFileChannelFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileChannel" type="java.nio.channels.FileChannel"/>
- <param name="buf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads len bytes in a loop using the channel of the stream
- @param fileChannel a FileChannel to read len bytes into buf
- @param buf The buffer to fill
- @param off offset from the buffer
- @param len the length of bytes to read
- @throws IOException if it could not read requested number of bytes
- for any reason (including EOF)]]>
- </doc>
- </method>
- <method name="skipFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="len" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Similar to readFully(). Skips bytes in a loop.
- @param in The InputStream to skip bytes from
- @param len number of bytes to skip.
- @throws IOException if it could not skip requested number of bytes
- for any reason (including EOF)]]>
- </doc>
- </method>
- <method name="cleanup"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <param name="closeables" type="java.io.Closeable[]"/>
- <doc>
- <![CDATA[Close the Closeable objects and <b>ignore</b> any {@link IOException} or
- null pointers. Must only be used for cleanup in exception handlers.
- @param log the log to record problems to at debug level. Can be null.
- @param closeables the objects to close]]>
- </doc>
- </method>
- <method name="closeStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.Closeable"/>
- <doc>
- <![CDATA[Closes the stream ignoring {@link IOException}.
- Must only be called in cleaning up from exception handlers.
- @param stream the Stream to close]]>
- </doc>
- </method>
- <method name="closeSocket"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sock" type="java.net.Socket"/>
- <doc>
- <![CDATA[Closes the socket ignoring {@link IOException}
- @param sock the Socket to close]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An utility class for I/O related functionality.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IOUtils -->
- <!-- start class org.apache.hadoop.io.IOUtils.NullOutputStream -->
- <class name="IOUtils.NullOutputStream" extends="java.io.OutputStream"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IOUtils.NullOutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[/dev/null of OutputStreams.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.IOUtils.NullOutputStream -->
- <!-- start class org.apache.hadoop.io.LongWritable -->
- <class name="LongWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="LongWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LongWritable" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="get" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a LongWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two LongWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for longs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.LongWritable -->
- <!-- start class org.apache.hadoop.io.LongWritable.Comparator -->
- <class name="LongWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LongWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A Comparator optimized for LongWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.LongWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.LongWritable.DecreasingComparator -->
- <class name="LongWritable.DecreasingComparator" extends="org.apache.hadoop.io.LongWritable.Comparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LongWritable.DecreasingComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="b" type="org.apache.hadoop.io.WritableComparable"/>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A decreasing Comparator optimized for LongWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.LongWritable.DecreasingComparator -->
- <!-- start class org.apache.hadoop.io.MapFile -->
- <class name="MapFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="rename"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="oldName" type="java.lang.String"/>
- <param name="newName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renames an existing map directory.]]>
- </doc>
- </method>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deletes the named map file.]]>
- </doc>
- </method>
- <method name="fix" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <param name="dryrun" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[This method attempts to fix a corrupt MapFile by re-creating its index.
- @param fs filesystem
- @param dir directory containing the MapFile data and index
- @param keyClass key class (has to be a subclass of Writable)
- @param valueClass value class (has to be a subclass of Writable)
- @param dryrun do not perform any changes, just report what needs to be done
- @return number of valid entries in this MapFile, or -1 if no fixing was needed
- @throws Exception]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="INDEX_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the index file.]]>
- </doc>
- </field>
- <field name="DATA_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the data file.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A file-based map from keys to values.
-
- <p>A map is a directory containing two files, the <code>data</code> file,
- containing all keys and values in the map, and a smaller <code>index</code>
- file, containing a fraction of the keys. The fraction is determined by
- {@link Writer#getIndexInterval()}.
- <p>The index file is read entirely into memory. Thus key implementations
- should try to keep themselves small.
- <p>Map files are created by adding entries in-order. To maintain a large
- database, perform updates by copying the previous version of a database and
- merging in a sorted change list, to create a new version of the database in
- a new file. Sorting large change lists can be done with {@link
- SequenceFile.Sorter}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapFile -->
- <!-- start class org.apache.hadoop.io.MapFile.Reader -->
- <class name="MapFile.Reader" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a map reader for the named map.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a map reader for the named map using the named comparator.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration, boolean"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Hook to allow subclasses to defer opening streams until further
- initialization is complete.
- @see #createDataFileReader(FileSystem, Path, Configuration)]]>
- </doc>
- </constructor>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of keys in this file.]]>
- </doc>
- </method>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of values in this file.]]>
- </doc>
- </method>
- <method name="open"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dirName" type="java.lang.String"/>
- <param name="comparator" type="org.apache.hadoop.io.WritableComparator"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createDataFileReader" return="org.apache.hadoop.io.SequenceFile.Reader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dataFile" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Override this method to specialize the type of
- {@link SequenceFile.Reader} returned.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-positions the reader before its first key.]]>
- </doc>
- </method>
- <method name="midKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the key at approximately the middle of the file.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="finalKey"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads the final key from the file.
- @param key key to read into]]>
- </doc>
- </method>
- <method name="seek" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Positions the reader at the named key, or if none such exists, at the
- first entry after the named key. Returns true iff the named key exists
- in this map.]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key/value pair in the map into <code>key</code> and
- <code>val</code>. Returns true if such a pair exists and false when at
- the end of the map]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the value for the named key, or null if none exists.]]>
- </doc>
- </method>
- <method name="getClosest" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Finds the record that is the closest match to the specified key.
- Returns <code>key</code> or if it does not exist, at the first entry
- after the named key.
-
- - * @param key - key that we're trying to find
- - * @param val - data value if key is found
- - * @return - the key that was the closest match or null if eof.]]>
- </doc>
- </method>
- <method name="getClosest" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <param name="before" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Finds the record that is the closest match to the specified key.
-
- @param key - key that we're trying to find
- @param val - data value if key is found
- @param before - IF true, and <code>key</code> does not exist, return
- the first entry that falls just before the <code>key</code>. Otherwise,
- return the record that sorts just after.
- @return - the key that was the closest match or null if eof.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the map.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provide access to an existing map.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapFile.Reader -->
- <!-- start class org.apache.hadoop.io.MapFile.Writer -->
- <class name="MapFile.Writer" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map for keys of the named class.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map for keys of the named class.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map for keys of the named class.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map for keys of the named class.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map using the named key comparator.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map using the named key comparator.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map using the named key comparator.]]>
- </doc>
- </constructor>
- <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named map using the named key comparator.]]>
- </doc>
- </constructor>
- <method name="getIndexInterval" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of entries that are added before an index entry is added.]]>
- </doc>
- </method>
- <method name="setIndexInterval"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="interval" type="int"/>
- <doc>
- <![CDATA[Sets the index interval.
- @see #getIndexInterval()]]>
- </doc>
- </method>
- <method name="setIndexInterval"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="interval" type="int"/>
- <doc>
- <![CDATA[Sets the index interval and stores it in conf
- @see #getIndexInterval()]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the map.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append a key/value pair to the map. The key must be greater or equal
- to the previous key added to the map.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Writes a new map.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapFile.Writer -->
- <!-- start class org.apache.hadoop.io.MapWritable -->
- <class name="MapWritable" extends="org.apache.hadoop.io.AbstractMapWritable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Map"/>
- <constructor name="MapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor.]]>
- </doc>
- </constructor>
- <constructor name="MapWritable" type="org.apache.hadoop.io.MapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor.
-
- @param other the map to copy from]]>
- </doc>
- </constructor>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="containsKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="containsValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="entrySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="isEmpty" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="keySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="put" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Writable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="putAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.util.Map"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="remove" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="values" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A Writable Map.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MapWritable -->
- <!-- start class org.apache.hadoop.io.MD5Hash -->
- <class name="MD5Hash" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="MD5Hash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash.]]>
- </doc>
- </constructor>
- <constructor name="MD5Hash" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash from a hex string.]]>
- </doc>
- </constructor>
- <constructor name="MD5Hash" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an MD5Hash with a specified value.]]>
- </doc>
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs, reads and returns an instance.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.io.MD5Hash"/>
- <doc>
- <![CDATA[Copy the contents of another instance into this instance.]]>
- </doc>
- </method>
- <method name="getDigest" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the digest bytes.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <doc>
- <![CDATA[Construct a hash value for a byte array.]]>
- </doc>
- </method>
- <method name="getDigester" return="java.security.MessageDigest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a thread local MD5 digester]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a hash value for the content from the InputStream.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Construct a hash value for a byte array.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Construct a hash value for a String.]]>
- </doc>
- </method>
- <method name="digest" return="org.apache.hadoop.io.MD5Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="org.apache.hadoop.io.UTF8"/>
- <doc>
- <![CDATA[Construct a hash value for a String.]]>
- </doc>
- </method>
- <method name="halfDigest" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a half-sized version of this MD5. Fits in a long]]>
- </doc>
- </method>
- <method name="quarterDigest" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a 32-bit digest of the MD5.
- @return the first 4 bytes of the md5]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is an MD5Hash whose digest contains the
- same values.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a hash code value for this object.
- Only uses the first 4 bytes, since md5s are evenly distributed.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.io.MD5Hash"/>
- <doc>
- <![CDATA[Compares this object with the specified object for order.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation of this object.]]>
- </doc>
- </method>
- <method name="setDigest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hex" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the digest value from a hex string.]]>
- </doc>
- </method>
- <field name="MD5_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Writable for MD5 hash values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MD5Hash -->
- <!-- start class org.apache.hadoop.io.MD5Hash.Comparator -->
- <class name="MD5Hash.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MD5Hash.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A WritableComparator optimized for MD5Hash keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MD5Hash.Comparator -->
- <!-- start class org.apache.hadoop.io.MultipleIOException -->
- <class name="MultipleIOException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getExceptions" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the underlying exceptions]]>
- </doc>
- </method>
- <method name="createIOException" return="java.io.IOException"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="exceptions" type="java.util.List"/>
- <doc>
- <![CDATA[A convenient method to create an {@link IOException}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Encapsulate a list of {@link IOException} into an {@link IOException}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.MultipleIOException -->
- <!-- start class org.apache.hadoop.io.NullWritable -->
- <class name="NullWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <method name="get" return="org.apache.hadoop.io.NullWritable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the single instance of this class.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Singleton Writable with no data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.NullWritable -->
- <!-- start class org.apache.hadoop.io.NullWritable.Comparator -->
- <class name="NullWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NullWritable.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Compare the buffers in serialized form.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A Comparator "optimized" for NullWritable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.NullWritable.Comparator -->
- <!-- start class org.apache.hadoop.io.ObjectWritable -->
- <class name="ObjectWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="ObjectWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ObjectWritable" type="java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ObjectWritable" type="java.lang.Class, java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the instance, or null if none.]]>
- </doc>
- </method>
- <method name="getDeclaredClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the class this is meant to be.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="instance" type="java.lang.Object"/>
- <doc>
- <![CDATA[Reset the instance.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeObject"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="instance" type="java.lang.Object"/>
- <param name="declaredClass" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="readObject" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="readObject" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="objectWritable" type="org.apache.hadoop.io.ObjectWritable"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of
- the preceding.]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A polymorphic Writable that writes an instance with it's class name.
- Handles arrays, strings and primitive types without a Writable wrapper.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ObjectWritable -->
- <!-- start class org.apache.hadoop.io.OutputBuffer -->
- <class name="OutputBuffer" extends="java.io.FilterOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OutputBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new empty buffer.]]>
- </doc>
- </constructor>
- <method name="getData" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current contents of the buffer.
- Data is only valid to {@link #getLength()}.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the length of the valid data currently in the buffer.]]>
- </doc>
- </method>
- <method name="reset" return="org.apache.hadoop.io.OutputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets the buffer to empty.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes bytes from a InputStream directly into the buffer.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A reusable {@link OutputStream} implementation that writes to an in-memory
- buffer.
- <p>This saves memory over creating a new OutputStream and
- ByteArrayOutputStream each time data is written.
- <p>Typical usage is something like the following:<pre>
- OutputBuffer buffer = new OutputBuffer();
- while (... loop condition ...) {
- buffer.reset();
- ... write buffer using OutputStream methods ...
- byte[] data = buffer.getData();
- int dataLength = buffer.getLength();
- ... write data to its ultimate destination ...
- }
- </pre>
- @see DataOutputBuffer
- @see InputBuffer]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.OutputBuffer -->
- <!-- start interface org.apache.hadoop.io.RawComparator -->
- <interface name="RawComparator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[<p>
- A {@link Comparator} that operates directly on byte representations of
- objects.
- </p>
- @param <T>
- @see DeserializerComparator]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.RawComparator -->
- <!-- start class org.apache.hadoop.io.ReadaheadPool -->
- <class name="ReadaheadPool" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getInstance" return="org.apache.hadoop.io.ReadaheadPool"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the singleton instance for the current process.]]>
- </doc>
- </method>
- <method name="readaheadStream" return="org.apache.hadoop.io.ReadaheadPool.ReadaheadRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="java.lang.String"/>
- <param name="fd" type="java.io.FileDescriptor"/>
- <param name="curPos" type="long"/>
- <param name="readaheadLength" type="long"/>
- <param name="maxOffsetToRead" type="long"/>
- <param name="lastReadahead" type="org.apache.hadoop.io.ReadaheadPool.ReadaheadRequest"/>
- <doc>
- <![CDATA[Issue a request to readahead on the given file descriptor.
- @param identifier a textual identifier that will be used in error
- messages (e.g. the file name)
- @param fd the file descriptor to read ahead
- @param curPos the current offset at which reads are being issued
- @param readaheadLength the configured length to read ahead
- @param maxOffsetToRead the maximum offset that will be readahead
- (useful if, for example, only some segment of the file is
- requested by the user). Pass {@link Long.MAX_VALUE} to allow
- readahead to the end of the file.
- @param lastReadahead the result returned by the previous invocation
- of this function on this file descriptor, or null if this is
- the first call
- @return an object representing this outstanding request, or null
- if no readahead was performed]]>
- </doc>
- </method>
- <method name="submitReadahead" return="org.apache.hadoop.io.ReadaheadPool.ReadaheadRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="java.lang.String"/>
- <param name="fd" type="java.io.FileDescriptor"/>
- <param name="off" type="long"/>
- <param name="len" type="long"/>
- <doc>
- <![CDATA[Submit a request to readahead on the given file descriptor.
- @param identifier a textual identifier used in error messages, etc.
- @param fd the file descriptor to readahead
- @param off the offset at which to start the readahead
- @param len the number of bytes to read
- @return an object representing this pending request]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Manages a pool of threads which can issue readahead requests on file descriptors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.ReadaheadPool -->
- <!-- start interface org.apache.hadoop.io.ReadaheadPool.ReadaheadRequest -->
- <interface name="ReadaheadPool.ReadaheadRequest" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Cancels the request for readahead. This should be used
- if the reader no longer needs the requested data, <em>before</em>
- closing the related file descriptor.
- It is safe to use even if the readahead request has already
- been fulfilled.]]>
- </doc>
- </method>
- <method name="getOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the requested offset]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the requested length]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An outstanding readahead request that has been submitted to
- the pool. This request may be pending or may have been
- completed.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.ReadaheadPool.ReadaheadRequest -->
- <!-- start class org.apache.hadoop.io.SecureIOUtils -->
- <class name="SecureIOUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecureIOUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="openForRead" return="java.io.FileInputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="expectedOwner" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open the given File for read access, verifying the expected user
- constraints.
- @param f the file that we are trying to open
- @param expectedOwner the expected user owner for the file
- @throws IOException if an IO Error occurred, or the user does not
- match]]>
- </doc>
- </method>
- <method name="createForWrite" return="java.io.FileOutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="java.io.File"/>
- <param name="permissions" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open the specified File for write access, ensuring that it does not exist.
- @param f the file that we want to create
- @param permissions we want to have on the file (if security is enabled)
- @throws AlreadyExistsException if the file already exists
- @throws IOException if any other error occurred]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class provides secure APIs for opening and creating files on the local
- disk. The main issue this class tries to handle is that of symlink traversal.
- <br/>
- An example of such an attack is:
- <ol>
- <li> Malicious user removes his task's syslog file, and puts a link to the
- jobToken file of a target user.</li>
- <li> Malicious user tries to open the syslog file via the servlet on the
- tasktracker.</li>
- <li> The tasktracker is unaware of the symlink, and simply streams the contents
- of the jobToken file. The malicious user can now access potentially sensitive
- map outputs, etc. of the target user's job.</li>
- </ol>
- A similar attack is possible involving the
- {@link org.apache.hadoop.mapred.TaskLogsTruncater}, but here it is to do
- with unsecure write to a file.
- <br/>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SecureIOUtils -->
- <!-- start class org.apache.hadoop.io.SecureIOUtils.AlreadyExistsException -->
- <class name="SecureIOUtils.AlreadyExistsException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecureIOUtils.AlreadyExistsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SecureIOUtils.AlreadyExistsException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Signals that an attempt to create a file at a given pathname has failed
- because another file already existed at that path.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SecureIOUtils.AlreadyExistsException -->
- <!-- start class org.apache.hadoop.io.SequenceFile -->
- <class name="SequenceFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link org.apache.hadoop.mapred.SequenceFileOutputFormat#getOutputCompressionType(org.apache.hadoop.mapred.JobConf)}
- to get {@link CompressionType} for job-outputs.">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the compression type for the reduce outputs
- @param job the job config to look in
- @return the kind of compression to use
- @deprecated Use
- {@link org.apache.hadoop.mapred.SequenceFileOutputFormat#getOutputCompressionType(org.apache.hadoop.mapred.JobConf)}
- to get {@link CompressionType} for job-outputs.]]>
- </doc>
- </method>
- <method name="setCompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use the one of the many SequenceFile.createWriter methods to specify
- the {@link CompressionType} while creating the {@link SequenceFile} or
- {@link org.apache.hadoop.mapred.SequenceFileOutputFormat#setOutputCompressionType(org.apache.hadoop.mapred.JobConf, org.apache.hadoop.io.SequenceFile.CompressionType)}
- to specify the {@link CompressionType} for job-outputs.
- or">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <param name="val" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <doc>
- <![CDATA[Set the compression type for sequence files.
- @param job the configuration to modify
- @param val the new compression type (none, block, record)
- @deprecated Use the one of the many SequenceFile.createWriter methods to specify
- the {@link CompressionType} while creating the {@link SequenceFile} or
- {@link org.apache.hadoop.mapred.SequenceFileOutputFormat#setOutputCompressionType(org.apache.hadoop.mapred.JobConf, org.apache.hadoop.io.SequenceFile.CompressionType)}
- to specify the {@link CompressionType} for job-outputs.
- or]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param progress The Progressable object to track progress.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param bufferSize buffer size for the underlaying outputstream.
- @param replication replication factor for the file.
- @param blockSize block size for the file.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="bufferSize" type="int"/>
- <param name="replication" type="short"/>
- <param name="blockSize" type="long"/>
- <param name="createParent" type="boolean"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param bufferSize buffer size for the underlaying outputstream.
- @param replication replication factor for the file.
- @param blockSize block size for the file.
- @param createParent create parent directory if non-existent
- @param compressionType The compression type.
- @param codec The compression codec.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="name" type="org.apache.hadoop.fs.Path"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of SequenceFile Writer.
- @param fs The configured filesystem.
- @param conf The configuration.
- @param name The name of the file.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param progress The Progressable object to track progress.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
- @param conf The configuration.
- @param out The stream on top which the writer is to be constructed.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @param metadata The metadata of the file.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valClass" type="java.lang.Class"/>
- <param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
- @param conf The configuration.
- @param out The stream on top which the writer is to be constructed.
- @param keyClass The 'key' type.
- @param valClass The 'value' type.
- @param compressionType The compression type.
- @param codec The compression codec.
- @return Returns the handle to the constructed SequenceFile Writer.
- @throws IOException]]>
- </doc>
- </method>
- <field name="SYNC_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of bytes between sync points.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[<code>SequenceFile</code>s are flat files consisting of binary key/value
- pairs.
-
- <p><code>SequenceFile</code> provides {@link Writer}, {@link Reader} and
- {@link Sorter} classes for writing, reading and sorting respectively.</p>
-
- There are three <code>SequenceFile</code> <code>Writer</code>s based on the
- {@link CompressionType} used to compress key/value pairs:
- <ol>
- <li>
- <code>Writer</code> : Uncompressed records.
- </li>
- <li>
- <code>RecordCompressWriter</code> : Record-compressed files, only compress
- values.
- </li>
- <li>
- <code>BlockCompressWriter</code> : Block-compressed files, both keys &
- values are collected in 'blocks'
- separately and compressed. The size of
- the 'block' is configurable.
- </ol>
-
- <p>The actual compression algorithm used to compress key and/or values can be
- specified by using the appropriate {@link CompressionCodec}.</p>
-
- <p>The recommended way is to use the static <tt>createWriter</tt> methods
- provided by the <code>SequenceFile</code> to chose the preferred format.</p>
- <p>The {@link Reader} acts as the bridge and can read any of the above
- <code>SequenceFile</code> formats.</p>
- <h4 id="Formats">SequenceFile Formats</h4>
-
- <p>Essentially there are 3 different formats for <code>SequenceFile</code>s
- depending on the <code>CompressionType</code> specified. All of them share a
- <a href="#Header">common header</a> described below.
-
- <h5 id="Header">SequenceFile Header</h5>
- <ul>
- <li>
- version - 3 bytes of magic header <b>SEQ</b>, followed by 1 byte of actual
- version number (e.g. SEQ4 or SEQ6)
- </li>
- <li>
- keyClassName -key class
- </li>
- <li>
- valueClassName - value class
- </li>
- <li>
- compression - A boolean which specifies if compression is turned on for
- keys/values in this file.
- </li>
- <li>
- blockCompression - A boolean which specifies if block-compression is
- turned on for keys/values in this file.
- </li>
- <li>
- compression codec - <code>CompressionCodec</code> class which is used for
- compression of keys and/or values (if compression is
- enabled).
- </li>
- <li>
- metadata - {@link Metadata} for this file.
- </li>
- <li>
- sync - A sync marker to denote end of the header.
- </li>
- </ul>
-
- <h5 id="#UncompressedFormat">Uncompressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record
- <ul>
- <li>Record length</li>
- <li>Key length</li>
- <li>Key</li>
- <li>Value</li>
- </ul>
- </li>
- <li>
- A sync-marker every few <code>100</code> bytes or so.
- </li>
- </ul>
- <h5 id="#RecordCompressedFormat">Record-Compressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record
- <ul>
- <li>Record length</li>
- <li>Key length</li>
- <li>Key</li>
- <li><i>Compressed</i> Value</li>
- </ul>
- </li>
- <li>
- A sync-marker every few <code>100</code> bytes or so.
- </li>
- </ul>
-
- <h5 id="#BlockCompressedFormat">Block-Compressed SequenceFile Format</h5>
- <ul>
- <li>
- <a href="#Header">Header</a>
- </li>
- <li>
- Record <i>Block</i>
- <ul>
- <li>Compressed key-lengths block-size</li>
- <li>Compressed key-lengths block</li>
- <li>Compressed keys block-size</li>
- <li>Compressed keys block</li>
- <li>Compressed value-lengths block-size</li>
- <li>Compressed value-lengths block</li>
- <li>Compressed values block-size</li>
- <li>Compressed values block</li>
- </ul>
- </li>
- <li>
- A sync-marker every few <code>100</code> bytes or so.
- </li>
- </ul>
-
- <p>The compressed blocks of key lengths and value lengths consist of the
- actual lengths of individual keys/values encoded in ZeroCompressedInteger
- format.</p>
-
- @see CompressionCodec]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile -->
- <!-- start class org.apache.hadoop.io.SequenceFile.CompressionType -->
- <class name="SequenceFile.CompressionType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.SequenceFile.CompressionType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.SequenceFile.CompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="NONE" type="org.apache.hadoop.io.SequenceFile.CompressionType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Do not compress records.]]>
- </doc>
- </field>
- <field name="RECORD" type="org.apache.hadoop.io.SequenceFile.CompressionType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compress values only, each separately.]]>
- </doc>
- </field>
- <field name="BLOCK" type="org.apache.hadoop.io.SequenceFile.CompressionType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compress sequences of records together in blocks.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The compression type used to compress key/value pairs in the
- {@link SequenceFile}.
-
- @see SequenceFile.Writer]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.CompressionType -->
- <!-- start class org.apache.hadoop.io.SequenceFile.Metadata -->
- <class name="SequenceFile.Metadata" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="SequenceFile.Metadata"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SequenceFile.Metadata" type="java.util.TreeMap"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="org.apache.hadoop.io.Text"/>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="org.apache.hadoop.io.Text"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- </method>
- <method name="getMetadata" return="java.util.TreeMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[The class encapsulating with the metadata of a file.
- The metadata of a file is a list of attribute name/value
- pairs of Text type.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.Metadata -->
- <!-- start class org.apache.hadoop.io.SequenceFile.Reader -->
- <class name="SequenceFile.Reader" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="SequenceFile.Reader" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open the named file.]]>
- </doc>
- </constructor>
- <method name="openFile" return="org.apache.hadoop.fs.FSDataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="bufferSize" type="int"/>
- <param name="length" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Override this method to specialize the type of
- {@link FSDataInputStream} returned.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the file.]]>
- </doc>
- </method>
- <method name="getKeyClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the name of the key class.]]>
- </doc>
- </method>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of keys in this file.]]>
- </doc>
- </method>
- <method name="getValueClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the name of the value class.]]>
- </doc>
- </method>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of values in this file.]]>
- </doc>
- </method>
- <method name="isCompressed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if values are compressed.]]>
- </doc>
- </method>
- <method name="isBlockCompressed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if records are block-compressed.]]>
- </doc>
- </method>
- <method name="getCompressionCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the compression codec of data in this file.]]>
- </doc>
- </method>
- <method name="getMetadata" return="org.apache.hadoop.io.SequenceFile.Metadata"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the metadata object of the file]]>
- </doc>
- </method>
- <method name="getCurrentValue"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the 'value' corresponding to the last read 'key'.
- @param val : The 'value' to be read.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the 'value' corresponding to the last read 'key'.
- @param val : The 'value' to be read.
- @throws IOException]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key in the file into <code>key</code>, skipping its
- value. True if another entry exists, and false at end of file.]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Writable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key/value pair in the file into <code>key</code> and
- <code>val</code>. Returns true if such a pair exists and false when at
- end of file]]>
- </doc>
- </method>
- <method name="next" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="Call {@link #nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)}.">
- <param name="buffer" type="org.apache.hadoop.io.DataOutputBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Call {@link #nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)}.]]>
- </doc>
- </method>
- <method name="createValueBytes" return="org.apache.hadoop.io.SequenceFile.ValueBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="nextRaw" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.DataOutputBuffer"/>
- <param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read 'raw' records.
- @param key - The buffer into which the key is read
- @param val - The 'raw' value
- @return Returns the total record length or -1 for end of file
- @throws IOException]]>
- </doc>
- </method>
- <method name="nextRawKey" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.DataOutputBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read 'raw' keys.
- @param key - The buffer into which the key is read
- @return Returns the key length or -1 for end of file
- @throws IOException]]>
- </doc>
- </method>
- <method name="next" return="java.lang.Object"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key in the file, skipping its
- value. Return null at end of file.]]>
- </doc>
- </method>
- <method name="nextRawValue" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read 'raw' values.
- @param val - The 'raw' value
- @return Returns the value length
- @throws IOException]]>
- </doc>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the current byte position in the input file.
- <p>The position passed must be a position returned by {@link
- SequenceFile.Writer#getLength()} when writing this file. To seek to an arbitrary
- position, use {@link SequenceFile.Reader#sync(long)}.]]>
- </doc>
- </method>
- <method name="sync"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the next sync mark past a given position.]]>
- </doc>
- </method>
- <method name="syncSeen" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true iff the previous call to next passed a sync mark.]]>
- </doc>
- </method>
- <method name="getPosition" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current byte position in the input file.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the name of the file.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Reads key/value pairs from a sequence-format file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.Reader -->
- <!-- start class org.apache.hadoop.io.SequenceFile.Sorter -->
- <class name="SequenceFile.Sorter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFile.Sorter" type="org.apache.hadoop.fs.FileSystem, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Sort and merge files containing the named classes.]]>
- </doc>
- </constructor>
- <constructor name="SequenceFile.Sorter" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Sort and merge using an arbitrary {@link RawComparator}.]]>
- </doc>
- </constructor>
- <method name="setFactor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="factor" type="int"/>
- <doc>
- <![CDATA[Set the number of streams to merge at once.]]>
- </doc>
- </method>
- <method name="getFactor" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of streams to merge at once.]]>
- </doc>
- </method>
- <method name="setMemory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="int"/>
- <doc>
- <![CDATA[Set the total amount of buffer memory, in bytes.]]>
- </doc>
- </method>
- <method name="getMemory" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total amount of buffer memory, in bytes.]]>
- </doc>
- </method>
- <method name="setProgressable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progressable" type="org.apache.hadoop.util.Progressable"/>
- <doc>
- <![CDATA[Set the progressable object in order to report progress.]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
- <param name="outFile" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteInput" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Perform a file sort from a set of input files into an output file.
- @param inFiles the files to be sorted
- @param outFile the sorted output file
- @param deleteInput should the input files be deleted as they are read?]]>
- </doc>
- </method>
- <method name="sortAndIterate" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
- <param name="tempDir" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteInput" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Perform a file sort from a set of input files and return an iterator.
- @param inFiles the files to be sorted
- @param tempDir the directory where temp files are created during sort
- @param deleteInput should the input files be deleted as they are read?
- @return iterator the RawKeyValueIterator]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFile" type="org.apache.hadoop.fs.Path"/>
- <param name="outFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The backwards compatible interface to sort.
- @param inFile the input file to sort
- @param outFile the sorted output file]]>
- </doc>
- </method>
- <method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="segments" type="java.util.List"/>
- <param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Merges the list of segments of type <code>SegmentDescriptor</code>
- @param segments the list of SegmentDescriptors
- @param tmpDir the directory to write temporary files into
- @return RawKeyValueIterator
- @throws IOException]]>
- </doc>
- </method>
- <method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
- <param name="deleteInputs" type="boolean"/>
- <param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Merges the contents of files passed in Path[] using a max factor value
- that is already set
- @param inNames the array of path names
- @param deleteInputs true if the input files should be deleted when
- unnecessary
- @param tmpDir the directory to write temporary files into
- @return RawKeyValueIteratorMergeQueue
- @throws IOException]]>
- </doc>
- </method>
- <method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
- <param name="deleteInputs" type="boolean"/>
- <param name="factor" type="int"/>
- <param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Merges the contents of files passed in Path[]
- @param inNames the array of path names
- @param deleteInputs true if the input files should be deleted when
- unnecessary
- @param factor the factor that will be used as the maximum merge fan-in
- @param tmpDir the directory to write temporary files into
- @return RawKeyValueIteratorMergeQueue
- @throws IOException]]>
- </doc>
- </method>
- <method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
- <param name="tempDir" type="org.apache.hadoop.fs.Path"/>
- <param name="deleteInputs" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Merges the contents of files passed in Path[]
- @param inNames the array of path names
- @param tempDir the directory for creating temp files during merge
- @param deleteInputs true if the input files should be deleted when
- unnecessary
- @return RawKeyValueIteratorMergeQueue
- @throws IOException]]>
- </doc>
- </method>
- <method name="cloneFileAttributes" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="outputFile" type="org.apache.hadoop.fs.Path"/>
- <param name="prog" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Clones the attributes (like compression of the input file and creates a
- corresponding Writer
- @param inputFile the path of the input file whose attributes should be
- cloned
- @param outputFile the path of the output file
- @param prog the Progressable to report status during the file write
- @return Writer
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="records" type="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"/>
- <param name="writer" type="org.apache.hadoop.io.SequenceFile.Writer"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes records from RawKeyValueIterator into a file represented by the
- passed writer
- @param records the RawKeyValueIterator
- @param writer the Writer created earlier
- @throws IOException]]>
- </doc>
- </method>
- <method name="merge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
- <param name="outFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Merge the provided files.
- @param inFiles the array of input path names
- @param outFile the final output file
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Sorts key/value pairs in a sequence-format file.
- <p>For best performance, applications should make sure that the {@link
- Writable#readFields(DataInput)} implementation of their keys is
- very efficient. In particular, it should avoid allocating memory.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.Sorter -->
- <!-- start interface org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator -->
- <interface name="SequenceFile.Sorter.RawKeyValueIterator" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getKey" return="org.apache.hadoop.io.DataOutputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the current raw key
- @return DataOutputBuffer
- @throws IOException]]>
- </doc>
- </method>
- <method name="getValue" return="org.apache.hadoop.io.SequenceFile.ValueBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the current raw value
- @return ValueBytes
- @throws IOException]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets up the current key and value (for getKey and getValue)
- @return true if there exists a key/value, false otherwise
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[closes the iterator so that the underlying streams can be closed
- @throws IOException]]>
- </doc>
- </method>
- <method name="getProgress" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the Progress object; this has a float (0.0 - 1.0)
- indicating the bytes processed by the iterator so far]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The interface to iterate over raw keys/values of SequenceFiles.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator -->
- <!-- start class org.apache.hadoop.io.SequenceFile.Sorter.SegmentDescriptor -->
- <class name="SequenceFile.Sorter.SegmentDescriptor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="SequenceFile.Sorter.SegmentDescriptor" type="long, long, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a segment
- @param segmentOffset the offset of the segment in the file
- @param segmentLength the length of the segment
- @param segmentPathName the path name of the file containing the segment]]>
- </doc>
- </constructor>
- <method name="doSync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Do the sync checks]]>
- </doc>
- </method>
- <method name="preserveInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="preserve" type="boolean"/>
- <doc>
- <![CDATA[Whether to delete the files when no longer needed]]>
- </doc>
- </method>
- <method name="shouldPreserveInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="nextRawKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills up the rawKey object with the key returned by the Reader
- @return true if there is a key returned; false, otherwise
- @throws IOException]]>
- </doc>
- </method>
- <method name="nextRawValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rawValue" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills up the passed rawValue with the value corresponding to the key
- read earlier
- @param rawValue
- @return the length of the value
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKey" return="org.apache.hadoop.io.DataOutputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the stored rawKey]]>
- </doc>
- </method>
- <method name="cleanup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The default cleanup. Subclasses can override this with a custom
- cleanup]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class defines a merge segment. This class can be subclassed to
- provide a customized cleanup method implementation. In this
- implementation, cleanup closes the file handle and deletes the file]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.Sorter.SegmentDescriptor -->
- <!-- start interface org.apache.hadoop.io.SequenceFile.ValueBytes -->
- <interface name="SequenceFile.ValueBytes" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="writeUncompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes the uncompressed bytes to the outStream.
- @param outStream : Stream to write uncompressed bytes into.
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeCompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write compressed bytes to outStream.
- Note: that it will NOT compress the bytes if they are not compressed.
- @param outStream : Stream to write compressed bytes into.]]>
- </doc>
- </method>
- <method name="getSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Size of stored data.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The interface to 'raw' values of SequenceFiles.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.SequenceFile.ValueBytes -->
- <!-- start class org.apache.hadoop.io.SequenceFile.Writer -->
- <class name="SequenceFile.Writer" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named file.]]>
- </doc>
- </constructor>
- <constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, java.lang.Class, org.apache.hadoop.util.Progressable, org.apache.hadoop.io.SequenceFile.Metadata"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named file with write-progress reporter.]]>
- </doc>
- </constructor>
- <constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, java.lang.Class, int, short, long, org.apache.hadoop.util.Progressable, org.apache.hadoop.io.SequenceFile.Metadata"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named file with write-progress reporter.]]>
- </doc>
- </constructor>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of keys in this file.]]>
- </doc>
- </method>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the class of values in this file.]]>
- </doc>
- </method>
- <method name="getCompressionCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the compression codec of data in this file.]]>
- </doc>
- </method>
- <method name="sync"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[create a sync point]]>
- </doc>
- </method>
- <method name="syncFs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[flush all currently written data to the file system]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the file.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Writable"/>
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append a key/value pair.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append a key/value pair.]]>
- </doc>
- </method>
- <method name="appendRaw"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keyData" type="byte[]"/>
- <param name="keyOffset" type="int"/>
- <param name="keyLength" type="int"/>
- <param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the current length of the output file.
- <p>This always returns a synchronized position. In other words,
- immediately after calling {@link SequenceFile.Reader#seek(long)} with a position
- returned by this method, {@link SequenceFile.Reader#next(Writable)} may be called. However
- the key may be earlier in the file than key last written when this
- method was called (e.g., with block-compression, it may be the first key
- in the block that was being written when this method was called).]]>
- </doc>
- </method>
- <field name="keySerializer" type="org.apache.hadoop.io.serializer.Serializer"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="uncompressedValSerializer" type="org.apache.hadoop.io.serializer.Serializer"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="compressedValSerializer" type="org.apache.hadoop.io.serializer.Serializer"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Write key/value pairs to a sequence-format file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SequenceFile.Writer -->
- <!-- start class org.apache.hadoop.io.SetFile -->
- <class name="SetFile" extends="org.apache.hadoop.io.MapFile"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SetFile"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A file-based set of keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SetFile -->
- <!-- start class org.apache.hadoop.io.SetFile.Reader -->
- <class name="SetFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SetFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a set reader for the named set.]]>
- </doc>
- </constructor>
- <constructor name="SetFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a set reader for the named set using the named comparator.]]>
- </doc>
- </constructor>
- <method name="seek" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next key in a set into <code>key</code>. Returns
- true if such a key exists and false when at the end of the set.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the matching key from a set into <code>key</code>.
- Returns <code>key</code>, or null if no match exists.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provide access to an existing set file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SetFile.Reader -->
- <!-- start class org.apache.hadoop.io.SetFile.Writer -->
- <class name="SetFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SetFile.Writer" type="org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="pass a Configuration too">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the named set for keys of the named class.
- @deprecated pass a Configuration too]]>
- </doc>
- </constructor>
- <constructor name="SetFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a set naming the element class and compression type.]]>
- </doc>
- </constructor>
- <constructor name="SetFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.io.SequenceFile.CompressionType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a set naming the element comparator and compression type.]]>
- </doc>
- </constructor>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Append a key to a set. The key must be strictly greater than the
- previous key added to the set.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Write a new set file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SetFile.Writer -->
- <!-- start class org.apache.hadoop.io.SortedMapWritable -->
- <class name="SortedMapWritable" extends="org.apache.hadoop.io.AbstractMapWritable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.SortedMap"/>
- <constructor name="SortedMapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor.]]>
- </doc>
- </constructor>
- <constructor name="SortedMapWritable" type="org.apache.hadoop.io.SortedMapWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor.
-
- @param other the map to copy from]]>
- </doc>
- </constructor>
- <method name="comparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="firstKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="headMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="lastKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="subMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="tailMap" return="java.util.SortedMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="containsKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="containsValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="entrySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="isEmpty" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="keySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="put" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="putAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.util.Map"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="remove" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="values" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A Writable SortedMap.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.SortedMapWritable -->
- <!-- start interface org.apache.hadoop.io.Stringifier -->
- <interface name="Stringifier" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Converts the object to a string representation
- @param obj the object to convert
- @return the string representation of the object
- @throws IOException if the object cannot be converted]]>
- </doc>
- </method>
- <method name="fromString" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restores the object from its string representation.
- @param str the string representation of the object
- @return restored object
- @throws IOException if the object cannot be restored]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes this object.
- @throws IOException if an I/O error occurs]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Stringifier interface offers two methods to convert an object
- to a string representation and restore the object given its
- string representation.
- @param <T> the class of the objects to stringify]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Stringifier -->
- <!-- start class org.apache.hadoop.io.Text -->
- <class name="Text" extends="org.apache.hadoop.io.BinaryComparable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Text" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a string.]]>
- </doc>
- </constructor>
- <constructor name="Text" type="org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from another text.]]>
- </doc>
- </constructor>
- <constructor name="Text" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a byte array.]]>
- </doc>
- </constructor>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the raw bytes; however, only data up to {@link #getLength()} is
- valid.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes in the byte array]]>
- </doc>
- </method>
- <method name="charAt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="position" type="int"/>
- <doc>
- <![CDATA[Returns the Unicode Scalar Value (32-bit integer value)
- for the character at <code>position</code>. Note that this
- method avoids using the converter or doing String instatiation
- @return the Unicode scalar value at position or -1
- if the position is invalid or points to a
- trailing byte]]>
- </doc>
- </method>
- <method name="find" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="what" type="java.lang.String"/>
- </method>
- <method name="find" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="what" type="java.lang.String"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Finds any occurence of <code>what</code> in the backing
- buffer, starting as position <code>start</code>. The starting
- position is measured in bytes and the return value is in
- terms of byte position in the buffer. The backing buffer is
- not converted to a string for this operation.
- @return byte position of the first occurence of the search
- string in the UTF-8 buffer or -1 if not found]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Set to contain the contents of a string.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <doc>
- <![CDATA[Set to a utf8 byte array]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[copy a text.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Set the Text to range of bytes
- @param utf8 the data to copy from
- @param start the first position of the new string
- @param len the number of bytes of the new string]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Append a range of bytes to the end of the given text
- @param utf8 the data to copy from
- @param start the first position to append from utf8
- @param len the number of bytes to append]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clear the string to empty.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert text back to string
- @see java.lang.Object#toString()]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[deserialize]]>
- </doc>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skips over one Text in the input.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[serialize
- write this object to out
- length uses zero-compressed encoding
- @see Writable#write(DataOutput)]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a Text with the same contents.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided byte array to a String using the
- UTF-8 encoding. If the input is malformed,
- replace by a default value.]]>
- </doc>
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- </method>
- <method name="decode" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <param name="replace" type="boolean"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided byte array to a String using the
- UTF-8 encoding. If <code>replace</code> is true, then
- malformed input is replaced with the
- substitution character, which is U+FFFD. Otherwise the
- method throws a MalformedInputException.]]>
- </doc>
- </method>
- <method name="encode" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided String to bytes using the
- UTF-8 encoding. If the input is malformed,
- invalid chars are replaced by a default value.
- @return ByteBuffer: bytes stores at ByteBuffer.array()
- and length is ByteBuffer.limit()]]>
- </doc>
- </method>
- <method name="encode" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <param name="replace" type="boolean"/>
- <exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
- <doc>
- <![CDATA[Converts the provided String to bytes using the
- UTF-8 encoding. If <code>replace</code> is true, then
- malformed input is replaced with the
- substitution character, which is U+FFFD. Otherwise the
- method throws a MalformedInputException.
- @return ByteBuffer: bytes stores at ByteBuffer.array()
- and length is ByteBuffer.limit()]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF8 encoded string from in]]>
- </doc>
- </method>
- <method name="writeString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a UTF8 encoded string to out]]>
- </doc>
- </method>
- <method name="validateUTF8"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
- <doc>
- <![CDATA[Check if a byte array contains valid utf-8
- @param utf8 byte array
- @throws MalformedInputException if the byte array contains invalid utf-8]]>
- </doc>
- </method>
- <method name="validateUTF8"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf8" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="len" type="int"/>
- <exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
- <doc>
- <![CDATA[Check to see if a byte array is valid utf-8
- @param utf8 the array of bytes
- @param start the offset of the first byte in the array
- @param len the length of the byte sequence
- @throws MalformedInputException if the byte array contains invalid bytes]]>
- </doc>
- </method>
- <method name="bytesToCodePoint" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Returns the next code point at the current position in
- the buffer. The buffer's position will be incremented.
- Any mark set on this buffer will be changed by this method!]]>
- </doc>
- </method>
- <method name="utf8Length" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[For the given string, returns the number of UTF-8 bytes
- required to encode the string.
- @param string text to encode
- @return number of UTF-8 bytes required to encode]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class stores text using standard UTF8 encoding. It provides methods
- to serialize, deserialize, and compare texts at byte level. The type of
- length is integer and is serialized using zero-compressed format. <p>In
- addition, it provides methods for string traversal without converting the
- byte array to a string. <p>Also includes utilities for
- serializing/deserialing a string, coding/decoding a string, checking if a
- byte array contains valid UTF8 code, calculating the length of an encoded
- string.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.Text -->
- <!-- start class org.apache.hadoop.io.Text.Comparator -->
- <class name="Text.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Text.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A WritableComparator optimized for Text keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.Text.Comparator -->
- <!-- start class org.apache.hadoop.io.TwoDArrayWritable -->
- <class name="TwoDArrayWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TwoDArrayWritable" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TwoDArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[][]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toArray" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="values" type="org.apache.hadoop.io.Writable[][]"/>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable[][]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A Writable for 2D arrays containing a matrix of instances of a class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.TwoDArrayWritable -->
- <!-- start class org.apache.hadoop.io.UTF8 -->
- <class name="UTF8" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="replaced by Text">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="UTF8"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="UTF8" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a given string.]]>
- </doc>
- </constructor>
- <constructor name="UTF8" type="org.apache.hadoop.io.UTF8"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct from a given string.]]>
- </doc>
- </constructor>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The raw bytes.]]>
- </doc>
- </method>
- <method name="getLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of bytes in the encoded string.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Set to contain the contents of a string.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.UTF8"/>
- <doc>
- <![CDATA[Set to contain the contents of a string.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skips over one UTF8 in the input.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.io.UTF8"/>
- <doc>
- <![CDATA[Compare two UTF8s.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert to a String.]]>
- </doc>
- </method>
- <method name="toStringChecked" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert to a string, checking for valid UTF8.
- @return the converted string
- @throws UTFDataFormatException if the underlying bytes contain invalid
- UTF8 data.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a UTF8 with the same contents.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Convert a string to a UTF-8 encoded byte array.
- @see String#getBytes(String)]]>
- </doc>
- </method>
- <method name="fromBytes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert a UTF-8 encoded byte array back into a string.
- @throws IOException if the byte array is invalid UTF8]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF-8 encoded string.
- @see DataInput#readUTF()]]>
- </doc>
- </method>
- <method name="writeString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a UTF-8 encoded string.
- @see DataOutput#writeUTF(String)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A WritableComparable for strings that uses the UTF8 encoding.
-
- <p>Also includes utilities for efficiently reading and writing UTF-8.
- Note that this decodes UTF-8 but actually encodes CESU-8, a variant of
- UTF-8: see http://en.wikipedia.org/wiki/CESU-8
- @deprecated replaced by Text]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.UTF8 -->
- <!-- start class org.apache.hadoop.io.UTF8.Comparator -->
- <class name="UTF8.Comparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UTF8.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A WritableComparator optimized for UTF8 keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.UTF8.Comparator -->
- <!-- start class org.apache.hadoop.io.VersionedWritable -->
- <class name="VersionedWritable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="VersionedWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getVersion" return="byte"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the version number of the current implementation.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A base class for Writables that provides version checking.
- <p>This is useful when a class may evolve, so that instances written by the
- old version of the class may still be processed by the new version. To
- handle this situation, {@link #readFields(DataInput)}
- implementations should catch {@link VersionMismatchException}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VersionedWritable -->
- <!-- start class org.apache.hadoop.io.VersionMismatchException -->
- <class name="VersionMismatchException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VersionMismatchException" type="byte, byte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string representation of this object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Thrown by {@link VersionedWritable#readFields(DataInput)} when the
- version of an object being read does not match the current implementation
- version as returned by {@link VersionedWritable#getVersion()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VersionMismatchException -->
- <!-- start class org.apache.hadoop.io.VIntWritable -->
- <class name="VIntWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="VIntWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="VIntWritable" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of this VIntWritable.]]>
- </doc>
- </method>
- <method name="get" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this VIntWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a VIntWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two VIntWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for integer values stored in variable-length format.
- Such values take between one and five bytes. Smaller values take fewer bytes.
-
- @see org.apache.hadoop.io.WritableUtils#readVInt(DataInput)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VIntWritable -->
- <!-- start class org.apache.hadoop.io.VLongWritable -->
- <class name="VLongWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="VLongWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="VLongWritable" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="get" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the value of this LongWritable.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns true iff <code>o</code> is a VLongWritable with the same value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compares two VLongWritables.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A WritableComparable for longs in a variable-length format. Such values take
- between one and five bytes. Smaller values take fewer bytes.
-
- @see org.apache.hadoop.io.WritableUtils#readVLong(DataInput)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.VLongWritable -->
- <!-- start interface org.apache.hadoop.io.Writable -->
- <interface name="Writable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize the fields of this object to <code>out</code>.
-
- @param out <code>DataOuput</code> to serialize this object into.
- @throws IOException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize the fields of this object from <code>in</code>.
-
- <p>For efficiency, implementations should attempt to re-use storage in the
- existing object where possible.</p>
-
- @param in <code>DataInput</code> to deseriablize this object from.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A serializable object which implements a simple, efficient, serialization
- protocol, based on {@link DataInput} and {@link DataOutput}.
- <p>Any <code>key</code> or <code>value</code> type in the Hadoop Map-Reduce
- framework implements this interface.</p>
-
- <p>Implementations typically implement a static <code>read(DataInput)</code>
- method which constructs a new instance, calls {@link #readFields(DataInput)}
- and returns the instance.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyWritable implements Writable {
- // Some data
- private int counter;
- private long timestamp;
-
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public static MyWritable read(DataInput in) throws IOException {
- MyWritable w = new MyWritable();
- w.readFields(in);
- return w;
- }
- }
- </pre></blockquote></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.Writable -->
- <!-- start interface org.apache.hadoop.io.WritableComparable -->
- <interface name="WritableComparable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Comparable"/>
- <doc>
- <![CDATA[A {@link Writable} which is also {@link Comparable}.
- <p><code>WritableComparable</code>s can be compared to each other, typically
- via <code>Comparator</code>s. Any type which is to be used as a
- <code>key</code> in the Hadoop Map-Reduce framework should implement this
- interface.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyWritableComparable implements WritableComparable {
- // Some data
- private int counter;
- private long timestamp;
-
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public int compareTo(MyWritableComparable w) {
- int thisValue = this.value;
- int thatValue = ((IntWritable)o).value;
- return (thisValue < thatValue ? -1 : (thisValue==thatValue ? 0 : 1));
- }
- }
- </pre></blockquote></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.WritableComparable -->
- <!-- start class org.apache.hadoop.io.WritableComparator -->
- <class name="WritableComparator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.RawComparator"/>
- <constructor name="WritableComparator" type="java.lang.Class"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct for a {@link WritableComparable} implementation.]]>
- </doc>
- </constructor>
- <constructor name="WritableComparator" type="java.lang.Class, boolean"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="get" return="org.apache.hadoop.io.WritableComparator"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get a comparator for a {@link WritableComparable} implementation.]]>
- </doc>
- </method>
- <method name="define"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="comparator" type="org.apache.hadoop.io.WritableComparator"/>
- <doc>
- <![CDATA[Register an optimized comparator for a {@link WritableComparable}
- implementation.]]>
- </doc>
- </method>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the WritableComparable implementation class.]]>
- </doc>
- </method>
- <method name="newKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new {@link WritableComparable} instance.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Optimization hook. Override this to make SequenceFile.Sorter's scream.
- <p>The default implementation reads the data into two {@link
- WritableComparable}s (using {@link
- Writable#readFields(DataInput)}, then calls {@link
- #compare(WritableComparable,WritableComparable)}.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="b" type="org.apache.hadoop.io.WritableComparable"/>
- <doc>
- <![CDATA[Compare two WritableComparables.
- <p> The default implementation uses the natural ordering, calling {@link
- Comparable#compareTo(Object)}.]]>
- </doc>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="java.lang.Object"/>
- <param name="b" type="java.lang.Object"/>
- </method>
- <method name="compareBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Lexicographic order of binary data.]]>
- </doc>
- </method>
- <method name="hashBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Compute hash for binary data.]]>
- </doc>
- </method>
- <method name="hashBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Compute hash for binary data.]]>
- </doc>
- </method>
- <method name="readUnsignedShort" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse an unsigned short from a byte array.]]>
- </doc>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse an integer from a byte array.]]>
- </doc>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a float from a byte array.]]>
- </doc>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a long from a byte array.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a double from a byte array.]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
- @param bytes byte array with decode long
- @param start starting index
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
- @param bytes byte array with the encoded integer
- @param start start index
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A Comparator for {@link WritableComparable}s.
- <p>This base implemenation uses the natural ordering. To define alternate
- orderings, override {@link #compare(WritableComparable,WritableComparable)}.
- <p>One may optimize compare-intensive operations by overriding
- {@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are
- provided to assist in optimized implementations of this method.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.WritableComparator -->
- <!-- start class org.apache.hadoop.io.WritableFactories -->
- <class name="WritableFactories" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setFactory"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="factory" type="org.apache.hadoop.io.WritableFactory"/>
- <doc>
- <![CDATA[Define a factory for a class.]]>
- </doc>
- </method>
- <method name="getFactory" return="org.apache.hadoop.io.WritableFactory"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Define a factory for a class.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create a new instance of a class with a defined factory.]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Create a new instance of a class with a defined factory.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Factories for non-public writables. Defining a factory permits {@link
- ObjectWritable} to be able to construct instances of non-public classes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.WritableFactories -->
- <!-- start interface org.apache.hadoop.io.WritableFactory -->
- <interface name="WritableFactory" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="newInstance" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a new instance.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A factory for a class of Writable.
- @see WritableFactories]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.WritableFactory -->
- <!-- start class org.apache.hadoop.io.WritableName -->
- <class name="WritableName" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setName"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writableClass" type="java.lang.Class"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name that a class should be known as to something other than the
- class name.]]>
- </doc>
- </method>
- <method name="addName"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writableClass" type="java.lang.Class"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add an alternate name for a class.]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writableClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Return the name for a class. Default is {@link Class#getName()}.]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the class for a name. Default is {@link Class#forName(String)}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Utility to permit renaming of Writable implementation classes without
- invalidiating files that contain their class name.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.WritableName -->
- <!-- start class org.apache.hadoop.io.WritableUtils -->
- <class name="WritableUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="WritableUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readCompressedByteArray" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skipCompressedByteArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedByteArray" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="bytes" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readCompressedString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedString" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeStringArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedStringArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readStringArray" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readCompressedStringArray" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="displayByteArray"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="byte[]"/>
- </method>
- <method name="clone" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="orig" type="org.apache.hadoop.io.Writable"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Make a copy of a writable object using serialization to a buffer.
- @param orig The object to copy
- @return The copied object]]>
- </doc>
- </method>
- <method name="cloneInto"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="use ReflectionUtils.cloneInto instead.">
- <param name="dst" type="org.apache.hadoop.io.Writable"/>
- <param name="src" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a copy of the writable object using serialiation to a buffer
- @param dst the object to copy from
- @param src the object to copy into, which is destroyed
- @throws IOException
- @deprecated use ReflectionUtils.cloneInto instead.]]>
- </doc>
- </method>
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes an integer to a binary stream with zero-compressed encoding.
- For -120 <= i <= 127, only one byte is used with the actual value.
- For other values of i, the first byte value indicates whether the
- integer is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -121 and -124, the following integer
- is positive, with number of bytes that follow are -(v+120).
- If the first byte value v is between -125 and -128, the following integer
- is negative, with number of bytes that follow are -(v+124). Bytes are
- stored in the high-non-zero-byte-first order.
- @param stream Binary output stream
- @param i Integer to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
- For -112 <= i <= 127, only one byte is used with the actual value.
- For other values of i, the first byte value indicates whether the
- long is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -113 and -120, the following long
- is positive, with number of bytes that follow are -(v+112).
- If the first byte value v is between -121 and -128, the following long
- is negative, with number of bytes that follow are -(v+120). Bytes are
- stored in the high-non-zero-byte-first order.
-
- @param stream Binary output stream
- @param i Long to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from input stream and returns it.
- @param stream Binary input stream
- @throws java.io.IOException
- @return deserialized long from stream.]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from input stream and returns it.
- @param stream Binary input stream
- @throws java.io.IOException
- @return deserialized integer from stream.]]>
- </doc>
- </method>
- <method name="isNegativeVInt" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Given the first byte of a vint/vlong, determine the sign
- @param value the first byte
- @return is the value negative]]>
- </doc>
- </method>
- <method name="decodeVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte"/>
- <doc>
- <![CDATA[Parse the first byte of a vint/vlong to determine the number of bytes
- @param value the first byte of the vint/vlong
- @return the total number of bytes (1 to 9)]]>
- </doc>
- </method>
- <method name="getVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="long"/>
- <doc>
- <![CDATA[Get the encoded length if an integer is stored in a variable-length format
- @return the encoded length]]>
- </doc>
- </method>
- <method name="readEnum" return="java.lang.Enum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="enumType" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read an Enum value from DataInput, Enums are read and written
- using String values.
- @param <T> Enum type
- @param in DataInput to read from
- @param enumType Class type of Enum
- @return Enum represented by String read from DataInput
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeEnum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="enumVal" type="java.lang.Enum"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[writes String value of enum to DataOutput.
- @param out Dataoutput stream
- @param enumVal enum value
- @throws IOException]]>
- </doc>
- </method>
- <method name="skipFully"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skip <i>len</i> number of bytes in input stream<i>in</i>
- @param in input stream
- @param len number of bytes to skip
- @throws IOException when skipped less number of bytes]]>
- </doc>
- </method>
- <method name="toByteArray" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writables" type="org.apache.hadoop.io.Writable[]"/>
- <doc>
- <![CDATA[Convert writables to a byte array]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.WritableUtils -->
- </package>
- <package name="org.apache.hadoop.io.compress">
- <!-- start class org.apache.hadoop.io.compress.BlockCompressorStream -->
- <class name="BlockCompressorStream" extends="org.apache.hadoop.io.compress.CompressorStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a {@link BlockCompressorStream}.
-
- @param out stream
- @param compressor compressor to be used
- @param bufferSize size of buffer
- @param compressionOverhead maximum 'overhead' of the compression
- algorithm with given bufferSize]]>
- </doc>
- </constructor>
- <constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a {@link BlockCompressorStream} with given output-stream and
- compressor.
- Use default of 512 as bufferSize and compressionOverhead of
- (1% of bufferSize + 12 bytes) = 18 bytes (zlib algorithm).
-
- @param out stream
- @param compressor compressor to be used]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the data provided to the compression codec, compressing no more
- than the buffer size less the compression overhead as specified during
- construction for each block.
- Each block contains the uncompressed length for the block, followed by
- one or more length-prefixed blocks of compressed data.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link org.apache.hadoop.io.compress.CompressorStream} which works
- with 'block-based' based compression algorithms, as opposed to
- 'stream-based' compression algorithms.
- It should be noted that this wrapper does not guarantee that blocks will
- be sized for the compressor. If the
- {@link org.apache.hadoop.io.compress.Compressor} requires buffering to
- effect meaningful compression, it is responsible for it.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BlockCompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.BlockDecompressorStream -->
- <class name="BlockDecompressorStream" extends="org.apache.hadoop.io.compress.DecompressorStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link BlockDecompressorStream}.
-
- @param in input stream
- @param decompressor decompressor to use
- @param bufferSize size of buffer
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link BlockDecompressorStream}.
-
- @param in input stream
- @param decompressor decompressor to use
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="BlockDecompressorStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link org.apache.hadoop.io.compress.DecompressorStream} which works
- with 'block-based' based compression algorithms, as opposed to
- 'stream-based' compression algorithms.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BlockDecompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.BZip2Codec -->
- <class name="BZip2Codec" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.SplittableCompressionCodec"/>
- <constructor name="BZip2Codec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BZip2Codec]]>
- </doc>
- </constructor>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates CompressionOutputStream for BZip2
- @param out
- The output Stream
- @return The BZip2 CompressionOutputStream
- @throws java.io.IOException
- Throws IO exception]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a compressor using given OutputStream.
- @return CompressionOutputStream
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This functionality is currently not supported.
- @return BZip2DummyCompressor.class]]>
- </doc>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This functionality is currently not supported.
- @return Compressor]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates CompressionInputStream to be used to read off uncompressed data.
- @param in
- The InputStream
- @return Returns CompressionInputStream for BZip2
- @throws java.io.IOException
- Throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This functionality is currently not supported.
- @return CompressionInputStream]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="seekableIn" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <param name="start" type="long"/>
- <param name="end" type="long"/>
- <param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates CompressionInputStream to be used to read off uncompressed data
- in one of the two reading modes. i.e. Continuous or Blocked reading modes
- @param seekableIn The InputStream
- @param start The start offset into the compressed stream
- @param end The end offset into the compressed stream
- @param readMode Controls whether progress is reported continuously or
- only at block boundaries.
- @return CompressionInputStream for BZip2 aligned at block boundaries]]>
- </doc>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This functionality is currently not supported.
- @return BZip2DummyDecompressor.class]]>
- </doc>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This functionality is currently not supported.
- @return Decompressor]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[.bz2 is recognized as the default extension for compressed BZip2 files
- @return A String telling the default bzip2 file extension]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class provides CompressionOutputStream and CompressionInputStream for
- compression and decompression. Currently we dont have an implementation of
- the Compressor and Decompressor interfaces, so those methods of
- CompressionCodec which have a Compressor or Decompressor type argument, throw
- UnsupportedOperationException.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.BZip2Codec -->
- <!-- start class org.apache.hadoop.io.compress.CodecPool -->
- <class name="CodecPool" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CodecPool"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get a {@link Compressor} for the given {@link CompressionCodec} from the
- pool or a new one.
- @param codec the <code>CompressionCodec</code> for which to get the
- <code>Compressor</code>
- @param conf the <code>Configuration</code> object which contains confs for creating or reinit the compressor
- @return <code>Compressor</code> for the given
- <code>CompressionCodec</code> from the pool or a new one]]>
- </doc>
- </method>
- <method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- </method>
- <method name="getDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
- <doc>
- <![CDATA[Get a {@link Decompressor} for the given {@link CompressionCodec} from the
- pool or a new one.
-
- @param codec the <code>CompressionCodec</code> for which to get the
- <code>Decompressor</code>
- @return <code>Decompressor</code> for the given
- <code>CompressionCodec</code> the pool or a new one]]>
- </doc>
- </method>
- <method name="returnCompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <doc>
- <![CDATA[Return the {@link Compressor} to the pool.
-
- @param compressor the <code>Compressor</code> to be returned to the pool]]>
- </doc>
- </method>
- <method name="returnDecompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <doc>
- <![CDATA[Return the {@link Decompressor} to the pool.
-
- @param decompressor the <code>Decompressor</code> to be returned to the
- pool]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A global compressor/decompressor pool used to save and reuse
- (possibly native) compression/decompression codecs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CodecPool -->
- <!-- start interface org.apache.hadoop.io.compress.CompressionCodec -->
- <interface name="CompressionCodec" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream}.
-
- @param out the location for the final output stream
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream} with the given {@link Compressor}.
-
- @param out the location for the final output stream
- @param compressor compressor to use
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Compressor} needed by this {@link CompressionCodec}.
-
- @return the type of compressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Compressor} for use by this {@link CompressionCodec}.
-
- @return a new compressor for use by this codec]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a stream decompressor that will read from the given input stream.
-
- @param in the stream to read compressed bytes from
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- {@link InputStream} with the given {@link Decompressor}.
-
- @param in the stream to read compressed bytes from
- @param decompressor decompressor to use
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Decompressor} needed by this {@link CompressionCodec}.
-
- @return the type of decompressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Decompressor} for use by this {@link CompressionCodec}.
-
- @return a new decompressor for use by this codec]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default filename extension for this kind of compression.
- @return the extension including the '.']]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class encapsulates a streaming compression/decompression pair.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.CompressionCodec -->
- <!-- start class org.apache.hadoop.io.compress.CompressionCodecFactory -->
- <class name="CompressionCodecFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressionCodecFactory" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Find the codecs specified in the config value io.compression.codecs
- and register them. Defaults to gzip and zip.]]>
- </doc>
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Print the extension map out as a string.]]>
- </doc>
- </method>
- <method name="getCodecClasses" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the list of codecs listed in the configuration
- @param conf the configuration to look in
- @return a list of the Configuration classes or null if the attribute
- was not set]]>
- </doc>
- </method>
- <method name="setCodecClasses"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="classes" type="java.util.List"/>
- <doc>
- <![CDATA[Sets a list of codec classes in the configuration.
- @param conf the configuration to modify
- @param classes the list of classes to set]]>
- </doc>
- </method>
- <method name="getCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the given file based on its
- filename suffix.
- @param file the filename to check
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecByClassName" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="classname" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name.
- @param classname the canonical class name of the codec
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecByName" return="org.apache.hadoop.io.compress.CompressionCodec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codecName" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name
- or by codec alias.
- <p/>
- Codec aliases are case insensitive.
- <p/>
- The code alias is the short class name (without the package name).
- If the short class name ends with 'Codec', then there are two aliases for
- the codec, the complete short class name and the short class name without
- the 'Codec' ending. For example for the 'GzipCodec' codec class name the
- alias are 'gzip' and 'gzipcodec'.
- @param codecName the canonical class name of the codec
- @return the codec object]]>
- </doc>
- </method>
- <method name="getCodecClassByName" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codecName" type="java.lang.String"/>
- <doc>
- <![CDATA[Find the relevant compression codec for the codec's canonical class name
- or by codec alias and returns its implemetation class.
- <p/>
- Codec aliases are case insensitive.
- <p/>
- The code alias is the short class name (without the package name).
- If the short class name ends with 'Codec', then there are two aliases for
- the codec, the complete short class name and the short class name without
- the 'Codec' ending. For example for the 'GzipCodec' codec class name the
- alias are 'gzip' and 'gzipcodec'.
- @param codecName the canonical class name of the codec
- @return the codec class]]>
- </doc>
- </method>
- <method name="removeSuffix" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="java.lang.String"/>
- <param name="suffix" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes a suffix from a filename, if it has it.
- @param filename the filename to strip
- @param suffix the suffix to remove
- @return the shortened filename]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[A little test program.
- @param args]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A factory that will find the correct codec for a given filename.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionCodecFactory -->
- <!-- start class org.apache.hadoop.io.compress.CompressionInputStream -->
- <class name="CompressionInputStream" extends="java.io.InputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.Seekable"/>
- <constructor name="CompressionInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a compression input stream that reads
- the decompressed bytes from the given stream.
-
- @param in The input stream to be compressed.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read bytes from the stream.
- Made abstract to prevent leakage to underlying stream.]]>
- </doc>
- </method>
- <method name="resetState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reset the decompressor to its initial state and discard any buffered data,
- as the underlying stream may have been repositioned.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method returns the current position in the stream.
- @return Current position in stream as a long]]>
- </doc>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[This method is current not supported.
- @throws UnsupportedOperationException]]>
- </doc>
- </method>
- <method name="seekToNewSource" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetPos" type="long"/>
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[This method is current not supported.
- @throws UnsupportedOperationException]]>
- </doc>
- </method>
- <field name="in" type="java.io.InputStream"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The input stream to be compressed.]]>
- </doc>
- </field>
- <field name="maxAvailableData" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A compression input stream.
- <p>Implementations are assumed to be buffered. This permits clients to
- reposition the underlying input stream then call {@link #resetState()},
- without having to also synchronize client buffers.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionInputStream -->
- <!-- start class org.apache.hadoop.io.compress.CompressionOutputStream -->
- <class name="CompressionOutputStream" extends="java.io.OutputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressionOutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a compression output stream that writes
- the compressed bytes to the given stream.
- @param out]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write compressed bytes to the stream.
- Made abstract to prevent leakage to underlying stream.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Finishes writing compressed data to the output stream
- without closing the underlying stream.]]>
- </doc>
- </method>
- <method name="resetState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reset the compression to the initial state.
- Does not reset the underlying stream.]]>
- </doc>
- </method>
- <field name="out" type="java.io.OutputStream"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The output stream to be compressed.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A compression output stream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressionOutputStream -->
- <!-- start interface org.apache.hadoop.io.compress.Compressor -->
- <interface name="Compressor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for compression.
- This should be called whenever #needsInput() returns
- <code>true</code> indicating that more input data is required.
-
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the input data buffer is empty and
- #setInput() should be called to provide more input.
-
- @return <code>true</code> if the input data buffer is empty and
- #setInput() should be called in order to provide more input.]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets preset dictionary for compression. A preset dictionary
- is used when the history buffer can be predetermined.
- @param b Dictionary data bytes
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of uncompressed bytes input so far.]]>
- </doc>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of compressed bytes output so far.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[When called, indicates that compression should end
- with the current contents of the input buffer.]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the compressed
- data output stream has been reached.
- @return <code>true</code> if the end of the compressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with compressed data. Returns actual number
- of bytes of compressed data. A return value of 0 indicates that
- needsInput() should be called in order to determine if more input
- data is required.
-
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of compressed data.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets compressor so that a new set of input data can be processed.]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Closes the compressor and discards any unprocessed input.]]>
- </doc>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Prepare the compressor to be used in a new stream with settings defined in
- the given Configuration
-
- @param conf Configuration from which new setting are fetched]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specification of a stream-based 'compressor' which can be
- plugged into a {@link CompressionOutputStream} to compress data.
- This is modelled after {@link java.util.zip.Deflater}]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.Compressor -->
- <!-- start class org.apache.hadoop.io.compress.CompressorStream -->
- <class name="CompressorStream" extends="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CompressorStream" type="java.io.OutputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow derived classes to directly set the underlying stream.
-
- @param out Underlying output stream.]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="compressor" type="org.apache.hadoop.io.compress.Compressor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="closed" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.io.compress.CompressorStream -->
- <!-- start interface org.apache.hadoop.io.compress.Decompressor -->
- <interface name="Decompressor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for decompression.
- This should be called if and only if {@link #needsInput()} returns
- <code>true</code> indicating that more input data is required.
- (Both native and non-native versions of various Decompressors require
- that the data passed in via <code>b[]</code> remain unmodified until
- the caller is explicitly notified--via {@link #needsInput()}--that the
- buffer may be safely modified. With this requirement, an extra
- buffer-copy can be avoided.)
-
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called to
- provide more input.
-
- @return <code>true</code> if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called in
- order to provide more input.]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets preset dictionary for compression. A preset dictionary
- is used when the history buffer can be predetermined.
- @param b Dictionary data bytes
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>true</code> if a preset dictionary is needed for decompression.
- @return <code>true</code> if a preset dictionary is needed for decompression]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the decompressed
- data output stream has been reached.
- @return <code>true</code> if the end of the decompressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with uncompressed data. Returns actual number
- of bytes of uncompressed data. A return value of 0 indicates that
- {@link #needsInput()} should be called in order to determine if more
- input data is required.
-
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of compressed data.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes remaining in the compressed-data buffer;
- typically called after the decompressor has finished decompressing
- the current gzip stream (a.k.a. "member").]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets decompressor and input and output buffers so that a new set of
- input data can be processed.]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Closes the decompressor and discards any unprocessed input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specification of a stream-based 'de-compressor' which can be
- plugged into a {@link CompressionInputStream} to compress data.
- This is modelled after {@link java.util.zip.Inflater}]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.Decompressor -->
- <!-- start class org.apache.hadoop.io.compress.DecompressorStream -->
- <class name="DecompressorStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="DecompressorStream" type="java.io.InputStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Allow derived classes to directly set the underlying stream.
-
- @param in Underlying input stream.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressedData" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="checkStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="skip" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="available" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="markSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="mark"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readlimit" type="int"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="eof" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="closed" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.io.compress.DecompressorStream -->
- <!-- start class org.apache.hadoop.io.compress.DefaultCodec -->
- <class name="DefaultCodec" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <constructor name="DefaultCodec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.io.compress.DefaultCodec -->
- <!-- start interface org.apache.hadoop.io.compress.DoNotPool -->
- <interface name="DoNotPool" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <doc>
- <![CDATA[This is a marker annotation that marks a compressor or decompressor
- type as not to be pooled.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.DoNotPool -->
- <!-- start class org.apache.hadoop.io.compress.GzipCodec -->
- <class name="GzipCodec" extends="org.apache.hadoop.io.compress.DefaultCodec"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GzipCodec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This class creates gzip compressors/decompressors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.GzipCodec -->
- <!-- start class org.apache.hadoop.io.compress.GzipCodec.GzipOutputStream -->
- <class name="GzipCodec.GzipOutputStream" extends="org.apache.hadoop.io.compress.CompressorStream"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="GzipCodec.GzipOutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="GzipCodec.GzipOutputStream" type="org.apache.hadoop.io.compress.CompressorStream"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow children types to put a different type in here.
- @param out the Deflater stream to use]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="resetState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A bridge that wraps around a DeflaterOutputStream to make it
- a CompressionOutputStream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.GzipCodec.GzipOutputStream -->
- <!-- start class org.apache.hadoop.io.compress.SnappyCodec -->
- <class name="SnappyCodec" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <constructor name="SnappyCodec"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration to be used by this object.
- @param conf the configuration object.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the configuration used by this object.
- @return the configuration object used by this objec.]]>
- </doc>
- </method>
- <method name="isNativeSnappyLoaded" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Are the native snappy libraries loaded & initialized?
- @param conf configuration
- @return true if loaded & initialized, otherwise false]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream}.
- @param out the location for the final output stream
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionOutputStream} that will write to the given
- {@link OutputStream} with the given {@link Compressor}.
- @param out the location for the final output stream
- @param compressor compressor to use
- @return a stream the user can write uncompressed data to have it compressed
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Compressor} needed by this {@link CompressionCodec}.
- @return the type of compressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Compressor} for use by this {@link CompressionCodec}.
- @return a new compressor for use by this codec]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- input stream.
- @param in the stream to read compressed bytes from
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a {@link CompressionInputStream} that will read from the given
- {@link InputStream} with the given {@link Decompressor}.
- @param in the stream to read compressed bytes from
- @param decompressor decompressor to use
- @return a stream to read uncompressed bytes from
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type of {@link Decompressor} needed by this {@link CompressionCodec}.
- @return the type of decompressor needed by this codec.]]>
- </doc>
- </method>
- <method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link Decompressor} for use by this {@link CompressionCodec}.
- @return a new decompressor for use by this codec]]>
- </doc>
- </method>
- <method name="getDefaultExtension" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default filename extension for this kind of compression.
- @return <code>.snappy</code>.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class creates snappy compressors/decompressors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.SnappyCodec -->
- <!-- start class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
- <class name="SplitCompressionInputStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SplitCompressionInputStream" type="java.io.InputStream, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="setStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="start" type="long"/>
- </method>
- <method name="setEnd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="end" type="long"/>
- </method>
- <method name="getAdjustedStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[After calling createInputStream, the values of start or end
- might change. So this method can be used to get the new value of start.
- @return The changed value of start]]>
- </doc>
- </method>
- <method name="getAdjustedEnd" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[After calling createInputStream, the values of start or end
- might change. So this method can be used to get the new value of end.
- @return The changed value of end]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An InputStream covering a range of compressed data. The start and end
- offsets requested by a client may be modified by the codec to fit block
- boundaries or other algorithm-dependent requirements.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
- <!-- start interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
- <interface name="SplittableCompressionCodec" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
- <method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="seekableIn" type="java.io.InputStream"/>
- <param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
- <param name="start" type="long"/>
- <param name="end" type="long"/>
- <param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a stream as dictated by the readMode. This method is used when
- the codecs wants the ability to work with the underlying stream positions.
- @param seekableIn The seekable input stream (seeks in compressed data)
- @param start The start offset into the compressed stream. May be changed
- by the underlying codec.
- @param end The end offset into the compressed stream. May be changed by
- the underlying codec.
- @param readMode Controls whether stream position is reported continuously
- from the compressed stream only only at block boundaries.
- @return a stream to read uncompressed bytes from]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This interface is meant to be implemented by those compression codecs
- which are capable to compress / decompress a stream starting at any
- arbitrary position.
- Especially the process of decompressing a stream starting at some arbitrary
- position is challenging. Most of the codecs are only able to successfully
- decompress a stream, if they start from the very beginning till the end.
- One of the reasons is the stored state at the beginning of the stream which
- is crucial for decompression.
- Yet there are few codecs which do not save the whole state at the beginning
- of the stream and hence can be used to de-compress stream starting at any
- arbitrary points. This interface is meant to be used by such codecs. Such
- codecs are highly valuable, especially in the context of Hadoop, because
- an input compressed file can be split and hence can be worked on by multiple
- machines in parallel.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
- <!-- start class org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE -->
- <class name="SplittableCompressionCodec.READ_MODE" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="CONTINUOUS" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYBLOCK" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[During decompression, data can be read off from the decompressor in two
- modes, namely continuous and blocked. Few codecs (e.g. BZip2) are capable
- of compressing data in blocks and then decompressing the blocks. In
- Blocked reading mode codecs inform 'end of block' events to its caller.
- While in continuous mode, the caller of codecs is unaware about the blocks
- and uncompressed data is spilled out like a continuous stream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE -->
- </package>
- <package name="org.apache.hadoop.io.compress.bzip2">
- <!-- start interface org.apache.hadoop.io.compress.bzip2.BZip2Constants -->
- <interface name="BZip2Constants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="baseBlockSize" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_ALPHA_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_CODE_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNA" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="N_GROUPS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="G_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="N_ITERS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_SELECTORS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NUM_OVERSHOOT_BYTES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="END_OF_BLOCK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[End of a BZip2 block]]>
- </doc>
- </field>
- <field name="END_OF_STREAM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[End of BZip2 stream.]]>
- </doc>
- </field>
- <field name="rNums" type="int[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This array really shouldn't be here. Again, for historical purposes it
- is.
- <p>
- FIXME: This array should be in a private or package private location,
- since it could be modified by malicious code.
- </p>]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Base class for both the compress and decompress classes. Holds common arrays,
- and static data.
- <p>
- This interface is public for historical purposes. You should have no need to
- use it.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.compress.bzip2.BZip2Constants -->
- <!-- start class org.apache.hadoop.io.compress.bzip2.BZip2DummyCompressor -->
- <class name="BZip2DummyCompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Compressor"/>
- <constructor name="BZip2DummyCompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[This is a dummy compressor for BZip2.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.bzip2.BZip2DummyCompressor -->
- <!-- start class org.apache.hadoop.io.compress.bzip2.BZip2DummyDecompressor -->
- <class name="BZip2DummyDecompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Decompressor"/>
- <constructor name="BZip2DummyDecompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <doc>
- <![CDATA[This is a dummy decompressor for BZip2.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.bzip2.BZip2DummyDecompressor -->
- <!-- start class org.apache.hadoop.io.compress.bzip2.CBZip2InputStream -->
- <class name="CBZip2InputStream" extends="java.io.InputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.bzip2.BZip2Constants"/>
- <constructor name="CBZip2InputStream" type="java.io.InputStream, org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs a new CBZip2InputStream which decompresses bytes read from the
- specified stream.
- <p>
- Although BZip2 headers are marked with the magic <tt>"Bz"</tt> this
- constructor expects the next byte in the stream to be the first one after
- the magic. Thus callers have to skip the first two bytes. Otherwise this
- constructor will throw an exception.
- </p>
- @throws IOException
- if the stream content is malformed or an I/O error occurs.
- @throws NullPointerException
- if <tt>in == null</tt>]]>
- </doc>
- </constructor>
- <constructor name="CBZip2InputStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getProcessedByteCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method reports the processed bytes so far. Please note that this
- statistic is only updated on block boundaries and only when the stream is
- initiated in BYBLOCK mode.]]>
- </doc>
- </method>
- <method name="updateProcessedByteCount"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[This method keeps track of raw processed compressed
- bytes.
- @param count count is the number of bytes to be
- added to raw processed bytes]]>
- </doc>
- </method>
- <method name="updateReportedByteCount"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[This method is called by the client of this
- class in case there are any corrections in
- the stream position. One common example is
- when client of this code removes starting BZ
- characters from the compressed stream.
- @param count count bytes are added to the reported bytes]]>
- </doc>
- </method>
- <method name="skipToNextMarker" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="marker" type="long"/>
- <param name="markerBitLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[This method tries to find the marker (passed to it as the first parameter)
- in the stream. It can find bit patterns of length <= 63 bits. Specifically
- this method is used in CBZip2InputStream to find the end of block (EOB)
- delimiter in the stream, starting from the current position of the stream.
- If marker is found, the stream position will be right after marker at the
- end of this call.
- @param marker The bit pattern to be found in the stream
- @param markerBitLength No of bits in the marker
- @throws IOException
- @throws IllegalArgumentException if marketBitLength is greater than 63]]>
- </doc>
- </method>
- <method name="reportCRCError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="numberOfBytesTillNextMarker" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the number of bytes between the current stream position
- and the immediate next BZip2 block marker.
- @param in
- The InputStream
- @return long Number of bytes between current stream position and the
- next BZip2 block start marker.
- @throws IOException]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dest" type="byte[]"/>
- <param name="offs" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[In CONTINOUS reading mode, this read method starts from the
- start of the compressed stream and end at the end of file by
- emitting un-compressed data. In this mode stream positioning
- is not announced and should be ignored.
- In BYBLOCK reading mode, this read method informs about the end
- of a BZip2 block by returning EOB. At this event, the compressed
- stream position is also announced. This announcement tells that
- how much of the compressed stream has been de-compressed and read
- out of this class. In between EOB events, the stream position is
- not updated.
- @throws IOException
- if the stream content is malformed or an I/O error occurs.
- @return int The return value greater than 0 are the bytes read. A value
- of -1 means end of stream while -2 represents end of block]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="BLOCK_DELIMITER" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EOS_DELIMITER" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An input stream that decompresses from the BZip2 format (without the file
- header chars) to be read as any other stream.
- <p>
- The decompression requires large amounts of memory. Thus you should call the
- {@link #close() close()} method as soon as possible, to force
- <tt>CBZip2InputStream</tt> to release the allocated memory. See
- {@link CBZip2OutputStream CBZip2OutputStream} for information about memory
- usage.
- </p>
- <p>
- <tt>CBZip2InputStream</tt> reads bytes from the compressed source stream via
- the single byte {@link java.io.InputStream#read() read()} method exclusively.
- Thus you should consider to use a buffered source stream.
- </p>
- <p>
- Instances of this class are not threadsafe.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.bzip2.CBZip2InputStream -->
- <!-- start class org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE -->
- <class name="CBZip2InputStream.STATE" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="EOF" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="START_BLOCK_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RAND_PART_A_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RAND_PART_B_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RAND_PART_C_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NO_RAND_PART_A_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NO_RAND_PART_B_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NO_RAND_PART_C_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NO_PROCESS_STATE" type="org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A state machine to keep track of current state of the de-coder]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.bzip2.CBZip2InputStream.STATE -->
- <!-- start class org.apache.hadoop.io.compress.bzip2.CBZip2OutputStream -->
- <class name="CBZip2OutputStream" extends="java.io.OutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.bzip2.BZip2Constants"/>
- <constructor name="CBZip2OutputStream" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs a new <tt>CBZip2OutputStream</tt> with a blocksize of 900k.
- <p>
- <b>Attention: </b>The caller is resonsible to write the two BZip2 magic
- bytes <tt>"BZ"</tt> to the specified stream prior to calling this
- constructor.
- </p>
- @param out *
- the destination stream.
- @throws IOException
- if an I/O error occurs in the specified stream.
- @throws NullPointerException
- if <code>out == null</code>.]]>
- </doc>
- </constructor>
- <constructor name="CBZip2OutputStream" type="java.io.OutputStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs a new <tt>CBZip2OutputStream</tt> with specified blocksize.
- <p>
- <b>Attention: </b>The caller is resonsible to write the two BZip2 magic
- bytes <tt>"BZ"</tt> to the specified stream prior to calling this
- constructor.
- </p>
- @param out
- the destination stream.
- @param blockSize
- the blockSize as 100k units.
- @throws IOException
- if an I/O error occurs in the specified stream.
- @throws IllegalArgumentException
- if <code>(blockSize < 1) || (blockSize > 9)</code>.
- @throws NullPointerException
- if <code>out == null</code>.
- @see #MIN_BLOCKSIZE
- @see #MAX_BLOCKSIZE]]>
- </doc>
- </constructor>
- <method name="hbMakeCodeLengths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="len" type="char[]"/>
- <param name="freq" type="int[]"/>
- <param name="alphaSize" type="int"/>
- <param name="maxLen" type="int"/>
- <doc>
- <![CDATA[This method is accessible by subclasses for historical purposes. If you
- don't know what it does then you don't need it.]]>
- </doc>
- </method>
- <method name="chooseBlockSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputLength" type="long"/>
- <doc>
- <![CDATA[Chooses a blocksize based on the given length of the data to compress.
- @return The blocksize, between {@link #MIN_BLOCKSIZE} and
- {@link #MAX_BLOCKSIZE} both inclusive. For a negative
- <tt>inputLength</tt> this method returns <tt>MAX_BLOCKSIZE</tt>
- always.
- @param inputLength
- The length of the data which will be compressed by
- <tt>CBZip2OutputStream</tt>.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="finalize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Throwable" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Overriden to close the stream.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getBlockSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the blocksize parameter specified at construction time.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offs" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="MIN_BLOCKSIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The minimum supported blocksize <tt> == 1</tt>.]]>
- </doc>
- </field>
- <field name="MAX_BLOCKSIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum supported blocksize <tt> == 9</tt>.]]>
- </doc>
- </field>
- <field name="SETMASK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="CLEARMASK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="GREATER_ICOST" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="LESSER_ICOST" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="SMALL_THRESH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="DEPTH_THRESH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="WORK_FACTOR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.]]>
- </doc>
- </field>
- <field name="QSORT_STACK_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is accessible by subclasses for historical purposes. If you
- don't know what it means then you don't need it.
- <p>
- If you are ever unlucky/improbable enough to get a stack overflow whilst
- sorting, increase the following constant and try again. In practice I
- have never seen the stack go above 27 elems, so the following limit seems
- very generous.
- </p>]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An output stream that compresses into the BZip2 format (without the file
- header chars) into another stream.
- <p>
- The compression requires large amounts of memory. Thus you should call the
- {@link #close() close()} method as soon as possible, to force
- <tt>CBZip2OutputStream</tt> to release the allocated memory.
- </p>
- <p>
- You can shrink the amount of allocated memory and maybe raise the compression
- speed by choosing a lower blocksize, which in turn may cause a lower
- compression ratio. You can avoid unnecessary memory allocation by avoiding
- using a blocksize which is bigger than the size of the input.
- </p>
- <p>
- You can compute the memory usage for compressing by the following formula:
- </p>
- <pre>
- <code>400k + (9 * blocksize)</code>.
- </pre>
- <p>
- To get the memory required for decompression by {@link CBZip2InputStream
- CBZip2InputStream} use
- </p>
- <pre>
- <code>65k + (5 * blocksize)</code>.
- </pre>
- <table width="100%" border="1">
- <colgroup> <col width="33%" /> <col width="33%" /> <col width="33%" />
- </colgroup>
- <tr>
- <th colspan="3">Memory usage by blocksize</th>
- </tr>
- <tr>
- <th align="right">Blocksize</th> <th align="right">Compression<br>
- memory usage</th> <th align="right">Decompression<br>
- memory usage</th>
- </tr>
- <tr>
- <td align="right">100k</td>
- <td align="right">1300k</td>
- <td align="right">565k</td>
- </tr>
- <tr>
- <td align="right">200k</td>
- <td align="right">2200k</td>
- <td align="right">1065k</td>
- </tr>
- <tr>
- <td align="right">300k</td>
- <td align="right">3100k</td>
- <td align="right">1565k</td>
- </tr>
- <tr>
- <td align="right">400k</td>
- <td align="right">4000k</td>
- <td align="right">2065k</td>
- </tr>
- <tr>
- <td align="right">500k</td>
- <td align="right">4900k</td>
- <td align="right">2565k</td>
- </tr>
- <tr>
- <td align="right">600k</td>
- <td align="right">5800k</td>
- <td align="right">3065k</td>
- </tr>
- <tr>
- <td align="right">700k</td>
- <td align="right">6700k</td>
- <td align="right">3565k</td>
- </tr>
- <tr>
- <td align="right">800k</td>
- <td align="right">7600k</td>
- <td align="right">4065k</td>
- </tr>
- <tr>
- <td align="right">900k</td>
- <td align="right">8500k</td>
- <td align="right">4565k</td>
- </tr>
- </table>
- <p>
- For decompression <tt>CBZip2InputStream</tt> allocates less memory if the
- bzipped input is smaller than one block.
- </p>
- <p>
- Instances of this class are not threadsafe.
- </p>
- <p>
- TODO: Update to BZip2 1.0.1
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.bzip2.CBZip2OutputStream -->
- </package>
- <package name="org.apache.hadoop.io.compress.snappy">
- <!-- start class org.apache.hadoop.io.compress.snappy.LoadSnappy -->
- <class name="LoadSnappy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LoadSnappy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isAvailable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if Snappy native library is loaded.
- @return <code>true</code> if Snappy native library is loaded,
- <code>false</code> if not.]]>
- </doc>
- </method>
- <method name="isLoaded" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if Snappy native library is loaded.
- @return <code>true</code> if Snappy native library is loaded,
- <code>false</code> if not.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Determines if Snappy native library is available and loads it if available.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.snappy.LoadSnappy -->
- <!-- start class org.apache.hadoop.io.compress.snappy.SnappyCompressor -->
- <class name="SnappyCompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Compressor"/>
- <constructor name="SnappyCompressor" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor.
- @param directBufferSize size of the direct buffer to be used.]]>
- </doc>
- </constructor>
- <constructor name="SnappyCompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor with the default buffer size.]]>
- </doc>
- </constructor>
- <method name="setInput"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for compression.
- This should be called whenever #needsInput() returns
- <code>true</code> indicating that more input data is required.
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Does nothing.]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the input data buffer is empty and
- #setInput() should be called to provide more input.
- @return <code>true</code> if the input data buffer is empty and
- #setInput() should be called in order to provide more input.]]>
- </doc>
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[When called, indicates that compression should end
- with the current contents of the input buffer.]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the compressed
- data output stream has been reached.
- @return <code>true</code> if the end of the compressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with compressed data. Returns actual number
- of bytes of compressed data. A return value of 0 indicates that
- needsInput() should be called in order to determine if more input
- data is required.
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of compressed data.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets compressor so that a new set of input data can be processed.]]>
- </doc>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Prepare the compressor to be used in a new stream with settings defined in
- the given Configuration
- @param conf Configuration from which new setting are fetched]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of bytes given to this compressor since last reset.]]>
- </doc>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return number of bytes consumed by callers of compress since last reset.]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Closes the compressor and discards any unprocessed input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link Compressor} based on the snappy compression algorithm.
- http://code.google.com/p/snappy/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.snappy.SnappyCompressor -->
- <!-- start class org.apache.hadoop.io.compress.snappy.SnappyDecompressor -->
- <class name="SnappyDecompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Decompressor"/>
- <constructor name="SnappyDecompressor" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor.
- @param directBufferSize size of the direct buffer to be used.]]>
- </doc>
- </constructor>
- <constructor name="SnappyDecompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new decompressor with the default buffer size.]]>
- </doc>
- </constructor>
- <method name="setInput"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Sets input data for decompression.
- This should be called if and only if {@link #needsInput()} returns
- <code>true</code> indicating that more input data is required.
- (Both native and non-native versions of various Decompressors require
- that the data passed in via <code>b[]</code> remain unmodified until
- the caller is explicitly notified--via {@link #needsInput()}--that the
- buffer may be safely modified. With this requirement, an extra
- buffer-copy can be avoided.)
- @param b Input data
- @param off Start offset
- @param len Length]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[Does nothing.]]>
- </doc>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called to
- provide more input.
- @return <code>true</code> if the input data buffer is empty and
- {@link #setInput(byte[], int, int)} should be called in
- order to provide more input.]]>
- </doc>
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>false</code>.
- @return <code>false</code>.]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the decompressed
- data output stream has been reached.
- @return <code>true</code> if the end of the decompressed
- data output stream has been reached.]]>
- </doc>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fills specified buffer with uncompressed data. Returns actual number
- of bytes of uncompressed data. A return value of 0 indicates that
- {@link #needsInput()} should be called in order to determine if more
- input data is required.
- @param b Buffer for the compressed data
- @param off Start offset of the data
- @param len Size of the buffer
- @return The actual number of bytes of compressed data.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns <code>0</code>.
- @return <code>0</code>.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets decompressor and input and output buffers so that a new set of
- input data can be processed.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link Decompressor} based on the snappy compression algorithm.
- http://code.google.com/p/snappy/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.snappy.SnappyDecompressor -->
- </package>
- <package name="org.apache.hadoop.io.compress.zlib">
- <!-- start class org.apache.hadoop.io.compress.zlib.BuiltInGzipDecompressor -->
- <class name="BuiltInGzipDecompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Decompressor"/>
- <constructor name="BuiltInGzipDecompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new (pure Java) gzip decompressor.]]>
- </doc>
- </constructor>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decompress the data (gzip header, deflate stream, gzip trailer) in the
- provided buffer.
- @return the number of decompressed bytes placed into b]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of compressed bytes input so far, including
- gzip header/trailer bytes.</p>
- @return the total (non-negative) number of compressed bytes read so far]]>
- </doc>
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes remaining in the input buffer; normally
- called when finished() is true to determine amount of post-gzip-stream
- data. Note that, other than the finished state with concatenated data
- after the end of the current gzip stream, this will never return a
- non-zero value unless called after {@link #setInput(byte[] b, int off,
- int len)} and before {@link #decompress(byte[] b, int off, int len)}.
- (That is, after {@link #decompress(byte[] b, int off, int len)} it
- always returns zero, except in finished state with concatenated data.)</p>
- @return the total (non-negative) number of unprocessed bytes in input]]>
- </doc>
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the end of the gzip substream (single "member") has been
- reached.</p>]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets everything, including the input buffer, regardless of whether the
- current gzip substream is finished.</p>]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link Decompressor} based on the popular gzip compressed file format.
- http://www.gzip.org/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.BuiltInGzipDecompressor -->
- <!-- start class org.apache.hadoop.io.compress.zlib.BuiltInZlibDeflater -->
- <class name="BuiltInZlibDeflater" extends="java.util.zip.Deflater"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Compressor"/>
- <constructor name="BuiltInZlibDeflater" type="int, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BuiltInZlibDeflater" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BuiltInZlibDeflater"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[reinit the compressor with the given configuration. It will reset the
- compressor's compression level and compression strategy. Different from
- <tt>ZlibCompressor</tt>, <tt>BuiltInZlibDeflater</tt> only support three
- kind of compression strategy: FILTERED, HUFFMAN_ONLY and DEFAULT_STRATEGY.
- It will use DEFAULT_STRATEGY as default if the configured compression
- strategy is not supported.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A wrapper around java.util.zip.Deflater to make it conform
- to org.apache.hadoop.io.compress.Compressor interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.BuiltInZlibDeflater -->
- <!-- start class org.apache.hadoop.io.compress.zlib.BuiltInZlibInflater -->
- <class name="BuiltInZlibInflater" extends="java.util.zip.Inflater"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Decompressor"/>
- <constructor name="BuiltInZlibInflater" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="BuiltInZlibInflater"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A wrapper around java.util.zip.Inflater to make it conform
- to org.apache.hadoop.io.compress.Decompressor interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.BuiltInZlibInflater -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibCompressor -->
- <class name="ZlibCompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Compressor"/>
- <constructor name="ZlibCompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor with the default compression level.
- Compressed data will be generated in ZLIB format.]]>
- </doc>
- </constructor>
- <constructor name="ZlibCompressor" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor, taking settings from the configuration.]]>
- </doc>
- </constructor>
- <constructor name="ZlibCompressor" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy, org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new compressor using the specified compression level.
- Compressed data will be generated in ZLIB format.
-
- @param level Compression level #CompressionLevel
- @param strategy Compression strategy #CompressionStrategy
- @param header Compression header #CompressionHeader
- @param directBufferSize Size of the direct buffer to be used.]]>
- </doc>
- </constructor>
- <method name="construct"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="level" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"/>
- <param name="strategy" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"/>
- <param name="header" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader"/>
- <param name="directBufferSize" type="int"/>
- </method>
- <method name="reinit"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Prepare the compressor to be used in a new stream with settings defined in
- the given Configuration. It will reset the compressor's compression level
- and compression strategy.
-
- @param conf Configuration storing new settings]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finish"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of compressed bytes output so far.
- @return the total (non-negative) number of compressed bytes output so far]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of uncompressed bytes input so far.</p>
- @return the total (non-negative) number of uncompressed bytes input so far]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A {@link Compressor} based on the popular
- zlib compression algorithm.
- http://www.zlib.net/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibCompressor -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader -->
- <class name="ZlibCompressor.CompressionHeader" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="windowBits" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="NO_HEADER" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[No headers/trailers/checksums.]]>
- </doc>
- </field>
- <field name="DEFAULT_HEADER" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default headers/trailers/checksums.]]>
- </doc>
- </field>
- <field name="GZIP_FORMAT" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Simple gzip headers/trailers.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The type of header for compressed data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionHeader -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel -->
- <class name="ZlibCompressor.CompressionLevel" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="NO_COMPRESSION" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression level for no compression.]]>
- </doc>
- </field>
- <field name="BEST_SPEED" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression level for fastest compression.]]>
- </doc>
- </field>
- <field name="BEST_COMPRESSION" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression level for best compression.]]>
- </doc>
- </field>
- <field name="DEFAULT_COMPRESSION" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default compression level.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The compression level for zlib library.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy -->
- <class name="ZlibCompressor.CompressionStrategy" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="FILTERED" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression strategy best used for data consisting mostly of small
- values with a somewhat random distribution. Forces more Huffman coding
- and less string matching.]]>
- </doc>
- </field>
- <field name="HUFFMAN_ONLY" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression strategy for Huffman coding only.]]>
- </doc>
- </field>
- <field name="RLE" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression strategy to limit match distances to one
- (run-length encoding).]]>
- </doc>
- </field>
- <field name="FIXED" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Compression strategy to prevent the use of dynamic Huffman codes,
- allowing for a simpler decoder for special applications.]]>
- </doc>
- </field>
- <field name="DEFAULT_STRATEGY" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default compression strategy.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The compression level for zlib library.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibDecompressor -->
- <class name="ZlibDecompressor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.compress.Decompressor"/>
- <constructor name="ZlibDecompressor" type="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new decompressor.]]>
- </doc>
- </constructor>
- <constructor name="ZlibDecompressor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setInput"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="setDictionary"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="needsInput" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="needsDictionary" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decompress" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getBytesWritten" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of uncompressed bytes output so far.
- @return the total (non-negative) number of uncompressed bytes output so far]]>
- </doc>
- </method>
- <method name="getBytesRead" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of compressed bytes input so far.</p>
- @return the total (non-negative) number of compressed bytes input so far]]>
- </doc>
- </method>
- <method name="getRemaining" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes remaining in the input buffers; normally
- called when finished() is true to determine amount of post-gzip-stream
- data.</p>
- @return the total (non-negative) number of unprocessed bytes in input]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resets everything including the input buffers (user and direct).</p>]]>
- </doc>
- </method>
- <method name="end"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finalize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A {@link Decompressor} based on the popular
- zlib compression algorithm.
- http://www.zlib.net/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibDecompressor -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader -->
- <class name="ZlibDecompressor.CompressionHeader" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="windowBits" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="NO_HEADER" type="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[No headers/trailers/checksums.]]>
- </doc>
- </field>
- <field name="DEFAULT_HEADER" type="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default headers/trailers/checksums.]]>
- </doc>
- </field>
- <field name="GZIP_FORMAT" type="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Simple gzip headers/trailers.]]>
- </doc>
- </field>
- <field name="AUTODETECT_GZIP_ZLIB" type="org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Autodetect gzip/zlib headers/trailers.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The headers to detect from compressed data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibDecompressor.CompressionHeader -->
- <!-- start class org.apache.hadoop.io.compress.zlib.ZlibFactory -->
- <class name="ZlibFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ZlibFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isNativeZlibLoaded" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Check if native-zlib code is loaded & initialized correctly and
- can be loaded for this job.
-
- @param conf configuration
- @return <code>true</code> if native-zlib is loaded & initialized
- and can be loaded for this job, else <code>false</code>]]>
- </doc>
- </method>
- <method name="getZlibCompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Return the appropriate type of the zlib compressor.
-
- @param conf configuration
- @return the appropriate type of the zlib compressor.]]>
- </doc>
- </method>
- <method name="getZlibCompressor" return="org.apache.hadoop.io.compress.Compressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Return the appropriate implementation of the zlib compressor.
-
- @param conf configuration
- @return the appropriate implementation of the zlib compressor.]]>
- </doc>
- </method>
- <method name="getZlibDecompressorType" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Return the appropriate type of the zlib decompressor.
-
- @param conf configuration
- @return the appropriate type of the zlib decompressor.]]>
- </doc>
- </method>
- <method name="getZlibDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Return the appropriate implementation of the zlib decompressor.
-
- @param conf configuration
- @return the appropriate implementation of the zlib decompressor.]]>
- </doc>
- </method>
- <method name="setCompressionStrategy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="strategy" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"/>
- </method>
- <method name="getCompressionStrategy" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionStrategy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="setCompressionLevel"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="level" type="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"/>
- </method>
- <method name="getCompressionLevel" return="org.apache.hadoop.io.compress.zlib.ZlibCompressor.CompressionLevel"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[A collection of factories to create the right
- zlib/gzip compressor/decompressor instances.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.compress.zlib.ZlibFactory -->
- </package>
- <package name="org.apache.hadoop.io.file.tfile">
- <!-- start class org.apache.hadoop.io.file.tfile.ByteArray -->
- <class name="ByteArray" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <constructor name="ByteArray" type="org.apache.hadoop.io.BytesWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructing a ByteArray from a {@link BytesWritable}.
-
- @param other]]>
- </doc>
- </constructor>
- <constructor name="ByteArray" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Wrap a whole byte array as a RawComparable.
-
- @param buffer
- the byte array buffer.]]>
- </doc>
- </constructor>
- <constructor name="ByteArray" type="byte[], int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Wrap a partial byte array as a RawComparable.
-
- @param buffer
- the byte array buffer.
- @param offset
- the starting offset
- @param len
- the length of the consecutive bytes to be wrapped.]]>
- </doc>
- </constructor>
- <method name="buffer" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the underlying buffer.]]>
- </doc>
- </method>
- <method name="offset" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the offset in the buffer.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the size of the byte array.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Adaptor class to wrap byte-array backed objects (including java byte array)
- as RawComparable objects.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.ByteArray -->
- <!-- start class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
- <class name="MetaBlockAlreadyExists" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exception - Meta Block with the same name already exists.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
- <!-- start class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
- <class name="MetaBlockDoesNotExist" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Exception - No such Meta Block with the given name.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
- <!-- start interface org.apache.hadoop.io.file.tfile.RawComparable -->
- <interface name="RawComparable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="buffer" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the underlying byte array.
-
- @return The underlying byte array.]]>
- </doc>
- </method>
- <method name="offset" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the offset of the first byte in the byte array.
-
- @return The offset of the first byte in the byte array.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the size of the byte range in the byte array.
-
- @return The size of the byte range in the byte array.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for objects that can be compared through {@link RawComparator}.
- This is useful in places where we need a single object reference to specify a
- range of bytes in a byte array, such as {@link Comparable} or
- {@link Collections#binarySearch(java.util.List, Object, Comparator)}
-
- The actual comparison among RawComparable's requires an external
- RawComparator and it is applications' responsibility to ensure two
- RawComparable are supposed to be semantically comparable with the same
- RawComparator.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.file.tfile.RawComparable -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile -->
- <class name="TFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="makeComparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Make a raw comparator from a string name.
-
- @param name
- Comparator name
- @return A RawComparable comparator.]]>
- </doc>
- </method>
- <method name="getSupportedCompressionAlgorithms" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get names of supported compression algorithms. The names are acceptable by
- TFile.Writer.
-
- @return Array of strings, each represents a supported compression
- algorithm. Currently, the following compression algorithms are
- supported.
- <ul>
- <li>"none" - No compression.
- <li>"lzo" - LZO compression.
- <li>"gz" - GZIP compression.
- </ul>]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Dumping the TFile information.
-
- @param args
- A list of TFile paths.]]>
- </doc>
- </method>
- <field name="COMPRESSION_GZ" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: gzip]]>
- </doc>
- </field>
- <field name="COMPRESSION_LZO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: lzo]]>
- </doc>
- </field>
- <field name="COMPRESSION_NONE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[compression: none]]>
- </doc>
- </field>
- <field name="COMPARATOR_MEMCMP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[comparator: memcmp]]>
- </doc>
- </field>
- <field name="COMPARATOR_JCLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[comparator prefix: java class]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A TFile is a container of key-value pairs. Both keys and values are type-less
- bytes. Keys are restricted to 64KB, value length is not restricted
- (practically limited to the available disk storage). TFile further provides
- the following features:
- <ul>
- <li>Block Compression.
- <li>Named meta data blocks.
- <li>Sorted or unsorted keys.
- <li>Seek by key or by file offset.
- </ul>
- The memory footprint of a TFile includes the following:
- <ul>
- <li>Some constant overhead of reading or writing a compressed block.
- <ul>
- <li>Each compressed block requires one compression/decompression codec for
- I/O.
- <li>Temporary space to buffer the key.
- <li>Temporary space to buffer the value (for TFile.Writer only). Values are
- chunk encoded, so that we buffer at most one chunk of user data. By default,
- the chunk buffer is 1MB. Reading chunked value does not require additional
- memory.
- </ul>
- <li>TFile index, which is proportional to the total number of Data Blocks.
- The total amount of memory needed to hold the index can be estimated as
- (56+AvgKeySize)*NumBlocks.
- <li>MetaBlock index, which is proportional to the total number of Meta
- Blocks.The total amount of memory needed to hold the index for Meta Blocks
- can be estimated as (40+AvgMetaBlockName)*NumMetaBlock.
- </ul>
- <p>
- The behavior of TFile can be customized by the following variables through
- Configuration:
- <ul>
- <li><b>tfile.io.chunk.size</b>: Value chunk size. Integer (in bytes). Default
- to 1MB. Values of the length less than the chunk size is guaranteed to have
- known value length in read time (See
- {@link TFile.Reader.Scanner.Entry#isValueLengthKnown()}).
- <li><b>tfile.fs.output.buffer.size</b>: Buffer size used for
- FSDataOutputStream. Integer (in bytes). Default to 256KB.
- <li><b>tfile.fs.input.buffer.size</b>: Buffer size used for
- FSDataInputStream. Integer (in bytes). Default to 256KB.
- </ul>
- <p>
- Suggestions on performance optimization.
- <ul>
- <li>Minimum block size. We recommend a setting of minimum block size between
- 256KB to 1MB for general usage. Larger block size is preferred if files are
- primarily for sequential access. However, it would lead to inefficient random
- access (because there are more data to decompress). Smaller blocks are good
- for random access, but require more memory to hold the block index, and may
- be slower to create (because we must flush the compressor stream at the
- conclusion of each data block, which leads to an FS I/O flush). Further, due
- to the internal caching in Compression codec, the smallest possible block
- size would be around 20KB-30KB.
- <li>The current implementation does not offer true multi-threading for
- reading. The implementation uses FSDataInputStream seek()+read(), which is
- shown to be much faster than positioned-read call in single thread mode.
- However, it also means that if multiple threads attempt to access the same
- TFile (using multiple scanners) simultaneously, the actual I/O is carried out
- sequentially even if they access different DFS blocks.
- <li>Compression codec. Use "none" if the data is not very compressable (by
- compressable, I mean a compression ratio at least 2:1). Generally, use "lzo"
- as the starting point for experimenting. "gz" overs slightly better
- compression ratio over "lzo" but requires 4x CPU to compress and 2x CPU to
- decompress, comparing to "lzo".
- <li>File system buffering, if the underlying FSDataInputStream and
- FSDataOutputStream is already adequately buffered; or if applications
- reads/writes keys and values in large buffers, we can reduce the sizes of
- input/output buffering in TFile layer by setting the configuration parameters
- "tfile.fs.input.buffer.size" and "tfile.fs.output.buffer.size".
- </ul>
-
- Some design rationale behind TFile can be found at <a
- href=https://issues.apache.org/jira/browse/HADOOP-3315>Hadoop-3315</a>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader -->
- <class name="TFile.Reader" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="TFile.Reader" type="org.apache.hadoop.fs.FSDataInputStream, long, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param fsdis
- FS input stream of the TFile.
- @param fileLength
- The length of TFile. This is required because we have no easy
- way of knowing the actual size of the input file through the
- File input stream.
- @param conf
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the reader. The state of the Reader object is undefined after
- close. Calling close() for multiple times has no effect.]]>
- </doc>
- </method>
- <method name="getComparatorName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the string representation of the comparator.
-
- @return If the TFile is not sorted by keys, an empty string will be
- returned. Otherwise, the actual comparator string that is
- provided during the TFile creation time will be returned.]]>
- </doc>
- </method>
- <method name="isSorted" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is the TFile sorted?
-
- @return true if TFile is sorted.]]>
- </doc>
- </method>
- <method name="getEntryCount" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of key-value pair entries in TFile.
-
- @return the number of key-value pairs in TFile]]>
- </doc>
- </method>
- <method name="getFirstKey" return="org.apache.hadoop.io.file.tfile.RawComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the first key in the TFile.
-
- @return The first key in the TFile.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLastKey" return="org.apache.hadoop.io.file.tfile.RawComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the last key in the TFile.
-
- @return The last key in the TFile.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getEntryComparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a Comparator object to compare Entries. It is useful when you want
- stores the entries in a collection (such as PriorityQueue) and perform
- sorting or comparison among entries based on the keys without copying out
- the key.
-
- @return An Entry Comparator..]]>
- </doc>
- </method>
- <method name="getComparator" return="java.util.Comparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get an instance of the RawComparator that is constructed based on the
- string comparator representation.
-
- @return a Comparator that can compare RawComparable's.]]>
- </doc>
- </method>
- <method name="getMetaBlock" return="java.io.DataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="MetaBlockDoesNotExist" type="org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist"/>
- <doc>
- <![CDATA[Stream access to a meta block.``
-
- @param name
- The name of the meta block.
- @return The input stream.
- @throws IOException
- on I/O error.
- @throws MetaBlockDoesNotExist
- If the meta block with the name does not exist.]]>
- </doc>
- </method>
- <method name="getRecordNumNear" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="offset" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the RecordNum for the first key-value pair in a compressed block
- whose byte offset in the TFile is greater than or equal to the specified
- offset.
-
- @param offset
- the user supplied offset.
- @return the RecordNum to the corresponding entry. If no such entry
- exists, it returns the total entry count.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKeyNear" return="org.apache.hadoop.io.file.tfile.RawComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="offset" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a sample key that is within a block whose starting offset is greater
- than or equal to the specified offset.
-
- @param offset
- The file offset.
- @return the key that fits the requirement; or null if no such key exists
- (which could happen if the offset is close to the end of the
- TFile).
- @throws IOException]]>
- </doc>
- </method>
- <method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner than can scan the whole TFile.
-
- @return The scanner object. A valid Scanner is always returned even if
- the TFile is empty.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createScannerByByteRange" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="offset" type="long"/>
- <param name="length" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner that covers a portion of TFile based on byte offsets.
-
- @param offset
- The beginning byte offset in the TFile.
- @param length
- The length of the region.
- @return The actual coverage of the returned scanner tries to match the
- specified byte-region but always round up to the compression
- block boundaries. It is possible that the returned scanner
- contains zero key-value pairs even if length is positive.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #createScannerByKey(byte[], byte[])} instead.">
- <param name="beginKey" type="byte[]"/>
- <param name="endKey" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner that covers a portion of TFile based on keys.
-
- @param beginKey
- Begin key of the scan (inclusive). If null, scan from the first
- key-value entry of the TFile.
- @param endKey
- End key of the scan (exclusive). If null, scan up to the last
- key-value entry of the TFile.
- @return The actual coverage of the returned scanner will cover all keys
- greater than or equal to the beginKey and less than the endKey.
- @throws IOException
-
- @deprecated Use {@link #createScannerByKey(byte[], byte[])} instead.]]>
- </doc>
- </method>
- <method name="createScannerByKey" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="beginKey" type="byte[]"/>
- <param name="endKey" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner that covers a portion of TFile based on keys.
-
- @param beginKey
- Begin key of the scan (inclusive). If null, scan from the first
- key-value entry of the TFile.
- @param endKey
- End key of the scan (exclusive). If null, scan up to the last
- key-value entry of the TFile.
- @return The actual coverage of the returned scanner will cover all keys
- greater than or equal to the beginKey and less than the endKey.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #createScannerByKey(RawComparable, RawComparable)}
- instead.">
- <param name="beginKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <param name="endKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner that covers a specific key range.
-
- @param beginKey
- Begin key of the scan (inclusive). If null, scan from the first
- key-value entry of the TFile.
- @param endKey
- End key of the scan (exclusive). If null, scan up to the last
- key-value entry of the TFile.
- @return The actual coverage of the returned scanner will cover all keys
- greater than or equal to the beginKey and less than the endKey.
- @throws IOException
-
- @deprecated Use {@link #createScannerByKey(RawComparable, RawComparable)}
- instead.]]>
- </doc>
- </method>
- <method name="createScannerByKey" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="beginKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <param name="endKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a scanner that covers a specific key range.
-
- @param beginKey
- Begin key of the scan (inclusive). If null, scan from the first
- key-value entry of the TFile.
- @param endKey
- End key of the scan (exclusive). If null, scan up to the last
- key-value entry of the TFile.
- @return The actual coverage of the returned scanner will cover all keys
- greater than or equal to the beginKey and less than the endKey.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createScannerByRecordNum" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="beginRecNum" type="long"/>
- <param name="endRecNum" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a scanner that covers a range of records.
-
- @param beginRecNum
- The RecordNum for the first record (inclusive).
- @param endRecNum
- The RecordNum for the last record (exclusive). To scan the whole
- file, either specify endRecNum==-1 or endRecNum==getEntryCount().
- @return The TFile scanner that covers the specified range of records.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[TFile Reader. Users may only read TFiles by creating TFile.Reader.Scanner.
- objects. A scanner may scan the whole TFile ({@link Reader#createScanner()}
- ) , a portion of TFile based on byte offsets (
- {@link Reader#createScannerByByteRange(long, long)}), or a portion of TFile with keys
- fall in a certain key range (for sorted TFile only,
- {@link Reader#createScannerByKey(byte[], byte[])} or
- {@link Reader#createScannerByKey(RawComparable, RawComparable)}).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner -->
- <class name="TFile.Reader.Scanner" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="TFile.Reader.Scanner" type="org.apache.hadoop.io.file.tfile.TFile.Reader, long, long"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param reader
- The TFile reader object.
- @param offBegin
- Begin byte-offset of the scan.
- @param offEnd
- End byte-offset of the scan.
- @throws IOException
-
- The offsets will be rounded to the beginning of a compressed
- block whose offset is greater than or equal to the specified
- offset.]]>
- </doc>
- </constructor>
- <constructor name="TFile.Reader.Scanner" type="org.apache.hadoop.io.file.tfile.TFile.Reader, org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param reader
- The TFile reader object.
- @param beginKey
- Begin key of the scan. If null, scan from the first <K,V>
- entry of the TFile.
- @param endKey
- End key of the scan. If null, scan up to the last <K, V> entry
- of the TFile.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="seekTo" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is greater than or equal
- to the input key. Synonymous to seekTo(key, 0, key.length). The entry
- returned by the previous entry() call will be invalid.
-
- @param key
- The input key
- @return true if we find an equal key.
- @throws IOException]]>
- </doc>
- </method>
- <method name="seekTo" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="keyOffset" type="int"/>
- <param name="keyLen" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is greater than or equal
- to the input key. The entry returned by the previous entry() call will
- be invalid.
-
- @param key
- The input key
- @param keyOffset
- offset in the key buffer.
- @param keyLen
- key buffer length.
- @return true if we find an equal key; false otherwise.
- @throws IOException]]>
- </doc>
- </method>
- <method name="rewind"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rewind to the first entry in the scanner. The entry returned by the
- previous entry() call will be invalid.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="seekToEnd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Seek to the end of the scanner. The entry returned by the previous
- entry() call will be invalid.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="lowerBound"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is greater than or equal
- to the input key. Synonymous to lowerBound(key, 0, key.length). The
- entry returned by the previous entry() call will be invalid.
-
- @param key
- The input key
- @throws IOException]]>
- </doc>
- </method>
- <method name="lowerBound"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="keyOffset" type="int"/>
- <param name="keyLen" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is greater than or equal
- to the input key. The entry returned by the previous entry() call will
- be invalid.
-
- @param key
- The input key
- @param keyOffset
- offset in the key buffer.
- @param keyLen
- key buffer length.
- @throws IOException]]>
- </doc>
- </method>
- <method name="upperBound"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is strictly greater than
- the input key. Synonymous to upperBound(key, 0, key.length). The entry
- returned by the previous entry() call will be invalid.
-
- @param key
- The input key
- @throws IOException]]>
- </doc>
- </method>
- <method name="upperBound"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="keyOffset" type="int"/>
- <param name="keyLen" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the first entry whose key is strictly greater than
- the input key. The entry returned by the previous entry() call will be
- invalid.
-
- @param key
- The input key
- @param keyOffset
- offset in the key buffer.
- @param keyLen
- key buffer length.
- @throws IOException]]>
- </doc>
- </method>
- <method name="advance" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the cursor to the next key-value pair. The entry returned by the
- previous entry() call will be invalid.
-
- @return true if the cursor successfully moves. False when cursor is
- already at the end location and cannot be advanced.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the scanner. Release all resources. The behavior of using the
- scanner after calling close is not defined. The entry returned by the
- previous entry() call will be invalid.]]>
- </doc>
- </method>
- <method name="atEnd" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is cursor at the end location?
-
- @return true if the cursor is at the end location.]]>
- </doc>
- </method>
- <method name="entry" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an entry to access the key and value.
-
- @return The Entry object to access the key and value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRecordNum" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the RecordNum corresponding to the entry pointed by the cursor.
- @return The RecordNum corresponding to the entry pointed by the cursor.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The TFile Scanner. The Scanner has an implicit cursor, which, upon
- creation, points to the first key-value pair in the scan range. If the
- scan range is empty, the cursor will point to the end of the scan range.
- <p>
- Use {@link Scanner#atEnd()} to test whether the cursor is at the end
- location of the scanner.
- <p>
- Use {@link Scanner#advance()} to move the cursor to the next key-value
- pair (or end if none exists). Use seekTo methods (
- {@link Scanner#seekTo(byte[])} or
- {@link Scanner#seekTo(byte[], int, int)}) to seek to any arbitrary
- location in the covered range (including backward seeking). Use
- {@link Scanner#rewind()} to seek back to the beginning of the scanner.
- Use {@link Scanner#seekToEnd()} to seek to the end of the scanner.
- <p>
- Actual keys and values may be obtained through {@link Scanner.Entry}
- object, which is obtained through {@link Scanner#entry()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry -->
- <class name="TFile.Reader.Scanner.Entry" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TFile.Reader.Scanner.Entry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKeyLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the length of the key.
-
- @return the length of the key.]]>
- </doc>
- </method>
- <method name="get"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.BytesWritable"/>
- <param name="value" type="org.apache.hadoop.io.BytesWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy the key and value in one shot into BytesWritables. This is
- equivalent to getKey(key); getValue(value);
-
- @param key
- BytesWritable to hold key.
- @param value
- BytesWritable to hold value
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKey" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.BytesWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy the key into BytesWritable. The input BytesWritable will be
- automatically resized to the actual key size.
-
- @param key
- BytesWritable to hold the key.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="org.apache.hadoop.io.BytesWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy the value into BytesWritable. The input BytesWritable will be
- automatically resized to the actual value size. The implementation
- directly uses the buffer inside BytesWritable for storing the value.
- The call does not require the value length to be known.
-
- @param value
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeKey" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writing the key to the output stream. This method avoids copying key
- buffer from Scanner into user buffer, then writing to the output
- stream.
-
- @param out
- The output stream
- @return the length of the key.
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writing the value to the output stream. This method avoids copying
- value data from Scanner into user buffer, then writing to the output
- stream. It does not require the value length to be known.
-
- @param out
- The output stream
- @return the length of the value
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKey" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy the key into user supplied buffer.
-
- @param buf
- The buffer supplied by user. The length of the buffer must
- not be shorter than the key length.
- @return The length of the key.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKey" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy the key into user supplied buffer.
-
- @param buf
- The buffer supplied by user.
- @param offset
- The starting offset of the user buffer where we should copy
- the key into. Requiring the key-length + offset no greater
- than the buffer length.
- @return The length of the key.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getKeyStream" return="java.io.DataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Streaming access to the key. Useful for desrializing the key into
- user objects.
-
- @return The input stream.]]>
- </doc>
- </method>
- <method name="getValueLength" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the length of the value. isValueLengthKnown() must be tested
- true.
-
- @return the length of the value.]]>
- </doc>
- </method>
- <method name="getValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy value into user-supplied buffer. User supplied buffer must be
- large enough to hold the whole value. The value part of the key-value
- pair pointed by the current cursor is not cached and can only be
- examined once. Calling any of the following functions more than once
- without moving the cursor will result in exception:
- {@link #getValue(byte[])}, {@link #getValue(byte[], int)},
- {@link #getValueStream}.
-
- @return the length of the value. Does not require
- isValueLengthKnown() to be true.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy value into user-supplied buffer. User supplied buffer must be
- large enough to hold the whole value (starting from the offset). The
- value part of the key-value pair pointed by the current cursor is not
- cached and can only be examined once. Calling any of the following
- functions more than once without moving the cursor will result in
- exception: {@link #getValue(byte[])}, {@link #getValue(byte[], int)},
- {@link #getValueStream}.
-
- @return the length of the value. Does not require
- isValueLengthKnown() to be true.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getValueStream" return="java.io.DataInputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stream access to value. The value part of the key-value pair pointed
- by the current cursor is not cached and can only be examined once.
- Calling any of the following functions more than once without moving
- the cursor will result in exception: {@link #getValue(byte[])},
- {@link #getValue(byte[], int)}, {@link #getValueStream}.
-
- @return The input stream for reading the value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="isValueLengthKnown" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check whether it is safe to call getValueLength().
-
- @return true if value length is known before hand. Values less than
- the chunk size will always have their lengths known before
- hand. Values that are written out as a whole (with advertised
- length up-front) will always have their lengths known in
- read.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <doc>
- <![CDATA[Compare the entry key to another key. Synonymous to compareTo(key, 0,
- key.length).
-
- @param buf
- The key buffer.
- @return comparison result between the entry key with the input key.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Compare the entry key to another key. Synonymous to compareTo(new
- ByteArray(buf, offset, length)
-
- @param buf
- The key buffer
- @param offset
- offset into the key buffer.
- @param length
- the length of the key.
- @return comparison result between the entry key with the input key.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
- <doc>
- <![CDATA[Compare an entry with a RawComparable object. This is useful when
- Entries are stored in a collection, and we want to compare a user
- supplied key.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare whether this and other points to the same key value.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Entry to a <Key, Value> pair.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry -->
- <!-- start class org.apache.hadoop.io.file.tfile.TFile.Writer -->
- <class name="TFile.Writer" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="TFile.Writer" type="org.apache.hadoop.fs.FSDataOutputStream, int, java.lang.String, java.lang.String, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param fsdos
- output stream for writing. Must be at position 0.
- @param minBlockSize
- Minimum compressed block size in bytes. A compression block will
- not be closed until it reaches this size except for the last
- block.
- @param compressName
- Name of the compression algorithm. Must be one of the strings
- returned by {@link TFile#getSupportedCompressionAlgorithms()}.
- @param comparator
- Leave comparator as null or empty string if TFile is not sorted.
- Otherwise, provide the string name for the comparison algorithm
- for keys. Two kinds of comparators are supported.
- <ul>
- <li>Algorithmic comparator: binary comparators that is language
- independent. Currently, only "memcmp" is supported.
- <li>Language-specific comparator: binary comparators that can
- only be constructed in specific language. For Java, the syntax
- is "jclass:", followed by the class name of the RawComparator.
- Currently, we only support RawComparators that can be
- constructed through the default constructor (with no
- parameters). Parameterized RawComparators such as
- {@link WritableComparator} or
- {@link JavaSerializationComparator} may not be directly used.
- One should write a wrapper class that inherits from such classes
- and use its default constructor to perform proper
- initialization.
- </ul>
- @param conf
- The configuration object.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the Writer. Resources will be released regardless of the exceptions
- being thrown. Future close calls will have no effect.
-
- The underlying FSDataOutputStream is not closed.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="value" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Adding a new key-value pair to the TFile. This is synonymous to
- append(key, 0, key.length, value, 0, value.length)
-
- @param key
- Buffer for key.
- @param value
- Buffer for value.
- @throws IOException]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="koff" type="int"/>
- <param name="klen" type="int"/>
- <param name="value" type="byte[]"/>
- <param name="voff" type="int"/>
- <param name="vlen" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Adding a new key-value pair to TFile.
-
- @param key
- buffer for key.
- @param koff
- offset in key buffer.
- @param klen
- length of key.
- @param value
- buffer for value.
- @param voff
- offset in value buffer.
- @param vlen
- length of value.
- @throws IOException
- Upon IO errors.
- <p>
- If an exception is thrown, the TFile will be in an inconsistent
- state. The only legitimate call after that would be close]]>
- </doc>
- </method>
- <method name="prepareAppendKey" return="java.io.DataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Obtain an output stream for writing a key into TFile. This may only be
- called when there is no active Key appending stream or value appending
- stream.
-
- @param length
- The expected length of the key. If length of the key is not
- known, set length = -1. Otherwise, the application must write
- exactly as many bytes as specified here before calling close on
- the returned output stream.
- @return The key appending output stream.
- @throws IOException]]>
- </doc>
- </method>
- <method name="prepareAppendValue" return="java.io.DataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Obtain an output stream for writing a value into TFile. This may only be
- called right after a key appending operation (the key append stream must
- be closed).
-
- @param length
- The expected length of the value. If length of the value is not
- known, set length = -1. Otherwise, the application must write
- exactly as many bytes as specified here before calling close on
- the returned output stream. Advertising the value size up-front
- guarantees that the value is encoded in one chunk, and avoids
- intermediate chunk buffering.
- @throws IOException]]>
- </doc>
- </method>
- <method name="prepareMetaBlock" return="java.io.DataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="compressName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="MetaBlockAlreadyExists" type="org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists"/>
- <doc>
- <![CDATA[Obtain an output stream for creating a meta block. This function may not
- be called when there is a key append stream or value append stream
- active. No more key-value insertion is allowed after a meta data block
- has been added to TFile.
-
- @param name
- Name of the meta block.
- @param compressName
- Name of the compression algorithm to be used. Must be one of the
- strings returned by
- {@link TFile#getSupportedCompressionAlgorithms()}.
- @return A DataOutputStream that can be used to write Meta Block data.
- Closing the stream would signal the ending of the block.
- @throws IOException
- @throws MetaBlockAlreadyExists
- the Meta Block with the same name already exists.]]>
- </doc>
- </method>
- <method name="prepareMetaBlock" return="java.io.DataOutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="MetaBlockAlreadyExists" type="org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists"/>
- <doc>
- <![CDATA[Obtain an output stream for creating a meta block. This function may not
- be called when there is a key append stream or value append stream
- active. No more key-value insertion is allowed after a meta data block
- has been added to TFile. Data will be compressed using the default
- compressor as defined in Writer's constructor.
-
- @param name
- Name of the meta block.
- @return A DataOutputStream that can be used to write Meta Block data.
- Closing the stream would signal the ending of the block.
- @throws IOException
- @throws MetaBlockAlreadyExists
- the Meta Block with the same name already exists.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[TFile Writer.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.TFile.Writer -->
- <!-- start class org.apache.hadoop.io.file.tfile.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="n" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encoding an integer into a variable-length encoding format. Synonymous to
- <code>Utils#writeVLong(out, n)</code>.
-
- @param out
- output stream
- @param n
- The integer to be encoded
- @throws IOException
- @see Utils#writeVLong(DataOutput, long)]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encoding a Long integer into a variable-length encoding format.
- <ul>
- <li>if n in [-32, 127): encode in one byte with the actual value.
- Otherwise,
- <li>if n in [-20*2^8, 20*2^8): encode in two bytes: byte[0] = n/256 - 52;
- byte[1]=n&0xff. Otherwise,
- <li>if n IN [-16*2^16, 16*2^16): encode in three bytes: byte[0]=n/2^16 -
- 88; byte[1]=(n>>8)&0xff; byte[2]=n&0xff. Otherwise,
- <li>if n in [-8*2^24, 8*2^24): encode in four bytes: byte[0]=n/2^24 - 112;
- byte[1] = (n>>16)&0xff; byte[2] = (n>>8)&0xff; byte[3]=n&0xff. Otherwise:
- <li>if n in [-2^31, 2^31): encode in five bytes: byte[0]=-125; byte[1] =
- (n>>24)&0xff; byte[2]=(n>>16)&0xff; byte[3]=(n>>8)&0xff; byte[4]=n&0xff;
- <li>if n in [-2^39, 2^39): encode in six bytes: byte[0]=-124; byte[1] =
- (n>>32)&0xff; byte[2]=(n>>24)&0xff; byte[3]=(n>>16)&0xff;
- byte[4]=(n>>8)&0xff; byte[5]=n&0xff
- <li>if n in [-2^47, 2^47): encode in seven bytes: byte[0]=-123; byte[1] =
- (n>>40)&0xff; byte[2]=(n>>32)&0xff; byte[3]=(n>>24)&0xff;
- byte[4]=(n>>16)&0xff; byte[5]=(n>>8)&0xff; byte[6]=n&0xff;
- <li>if n in [-2^55, 2^55): encode in eight bytes: byte[0]=-122; byte[1] =
- (n>>48)&0xff; byte[2] = (n>>40)&0xff; byte[3]=(n>>32)&0xff;
- byte[4]=(n>>24)&0xff; byte[5]=(n>>16)&0xff; byte[6]=(n>>8)&0xff;
- byte[7]=n&0xff;
- <li>if n in [-2^63, 2^63): encode in nine bytes: byte[0]=-121; byte[1] =
- (n>>54)&0xff; byte[2] = (n>>48)&0xff; byte[3] = (n>>40)&0xff;
- byte[4]=(n>>32)&0xff; byte[5]=(n>>24)&0xff; byte[6]=(n>>16)&0xff;
- byte[7]=(n>>8)&0xff; byte[8]=n&0xff;
- </ul>
-
- @param out
- output stream
- @param n
- the integer number
- @throws IOException]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decoding the variable-length integer. Synonymous to
- <code>(int)Utils#readVLong(in)</code>.
-
- @param in
- input stream
- @return the decoded integer
- @throws IOException
-
- @see Utils#readVLong(DataInput)]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decoding the variable-length integer. Suppose the value of the first byte
- is FB, and the following bytes are NB[*].
- <ul>
- <li>if (FB >= -32), return (long)FB;
- <li>if (FB in [-72, -33]), return (FB+52)<<8 + NB[0]&0xff;
- <li>if (FB in [-104, -73]), return (FB+88)<<16 + (NB[0]&0xff)<<8 +
- NB[1]&0xff;
- <li>if (FB in [-120, -105]), return (FB+112)<<24 + (NB[0]&0xff)<<16 +
- (NB[1]&0xff)<<8 + NB[2]&0xff;
- <li>if (FB in [-128, -121]), return interpret NB[FB+129] as a signed
- big-endian integer.
-
- @param in
- input stream
- @return the decoded long integer.
- @throws IOException]]>
- </doc>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <param name="s" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a String as a VInt n, followed by n Bytes as in Text format.
-
- @param out
- @param s
- @throws IOException]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a String as a VInt n, followed by n Bytes in Text format.
-
- @param in
- The input stream.
- @return The string
- @throws IOException]]>
- </doc>
- </method>
- <method name="lowerBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="java.lang.Object"/>
- <param name="cmp" type="java.util.Comparator"/>
- <doc>
- <![CDATA[Lower bound binary search. Find the index to the first element in the list
- that compares greater than or equal to key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @param cmp
- Comparator for the key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="upperBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="java.lang.Object"/>
- <param name="cmp" type="java.util.Comparator"/>
- <doc>
- <![CDATA[Upper bound binary search. Find the index to the first element in the list
- that compares greater than the input key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @param cmp
- Comparator for the key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="lowerBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Lower bound binary search. Find the index to the first element in the list
- that compares greater than or equal to key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <method name="upperBound" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Upper bound binary search. Find the index to the first element in the list
- that compares greater than the input key.
-
- @param <T>
- Type of the input key.
- @param list
- The list
- @param key
- The input key.
- @return The index to the desired element if it exists; or list.size()
- otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Supporting Utility classes used by TFile, and shared by users of TFile.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.Utils -->
- <!-- start class org.apache.hadoop.io.file.tfile.Utils.Version -->
- <class name="Utils.Version" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Utils.Version" type="java.io.DataInput"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct the Version object by reading from the input stream.
-
- @param in
- input stream
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="Utils.Version" type="short, short"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
-
- @param major
- major version.
- @param minor
- minor version.]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the objec to a DataOutput. The serialized format of the Version is
- major version followed by minor version, both as big-endian short
- integers.
-
- @param out
- The DataOutput object.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getMajor" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the major version.
-
- @return Major version.]]>
- </doc>
- </method>
- <method name="getMinor" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the minor version.
-
- @return The minor version.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the size of the serialized Version object.
-
- @return serialized size of the version object.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a string representation of the version.]]>
- </doc>
- </method>
- <method name="compatibleWith" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.io.file.tfile.Utils.Version"/>
- <doc>
- <![CDATA[Test compatibility.
-
- @param other
- The Version object to test compatibility with.
- @return true if both versions have the same major version number; false
- otherwise.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.io.file.tfile.Utils.Version"/>
- <doc>
- <![CDATA[Compare this version with another version.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A generic Version class. We suggest applications built on top of TFile use
- this class to maintain version information in their meta blocks.
-
- A version number consists of a major version and a minor version. The
- suggested usage of major and minor version number is to increment major
- version number when the new storage format is not backward compatible, and
- increment the minor version otherwise.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.file.tfile.Utils.Version -->
- </package>
- <package name="org.apache.hadoop.io.nativeio">
- <!-- start class org.apache.hadoop.io.nativeio.Errno -->
- <class name="Errno" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.io.nativeio.Errno[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.io.nativeio.Errno"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="EPERM" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOENT" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ESRCH" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EINTR" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EIO" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENXIO" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="E2BIG" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOEXEC" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EBADF" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ECHILD" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EAGAIN" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOMEM" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EACCES" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EFAULT" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOTBLK" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EBUSY" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EEXIST" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EXDEV" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENODEV" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOTDIR" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EISDIR" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EINVAL" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENFILE" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EMFILE" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOTTY" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ETXTBSY" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EFBIG" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENOSPC" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ESPIPE" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EROFS" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EMLINK" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EPIPE" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EDOM" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ERANGE" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNKNOWN" type="org.apache.hadoop.io.nativeio.Errno"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Enum representing POSIX errno values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.nativeio.Errno -->
- <!-- start class org.apache.hadoop.io.nativeio.NativeIO -->
- <class name="NativeIO" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NativeIO"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isAvailable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if the JNI-based native IO extensions are available.]]>
- </doc>
- </method>
- <method name="open" return="java.io.FileDescriptor"
- abstract="false" native="true" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <param name="flags" type="int"/>
- <param name="mode" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrapper around open(2)]]>
- </doc>
- </method>
- <method name="fstat" return="org.apache.hadoop.io.nativeio.NativeIO.Stat"
- abstract="false" native="true" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fd" type="java.io.FileDescriptor"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrapper around fstat(2)]]>
- </doc>
- </method>
- <method name="chmod"
- abstract="false" native="true" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <param name="mode" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrapper around chmod(2)]]>
- </doc>
- </method>
- <method name="posixFadviseIfPossible"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fd" type="java.io.FileDescriptor"/>
- <param name="offset" type="long"/>
- <param name="len" type="long"/>
- <param name="flags" type="int"/>
- <exception name="NativeIOException" type="org.apache.hadoop.io.nativeio.NativeIOException"/>
- <doc>
- <![CDATA[Call posix_fadvise on the given file descriptor. See the manpage
- for this syscall for more information. On systems where this
- call is not available, does nothing.
- @throws NativeIOException if there is an error with the syscall]]>
- </doc>
- </method>
- <method name="syncFileRangeIfPossible"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fd" type="java.io.FileDescriptor"/>
- <param name="offset" type="long"/>
- <param name="nbytes" type="long"/>
- <param name="flags" type="int"/>
- <exception name="NativeIOException" type="org.apache.hadoop.io.nativeio.NativeIOException"/>
- <doc>
- <![CDATA[Call sync_file_range on the given file descriptor. See the manpage
- for this syscall for more information. On systems where this
- call is not available, does nothing.
- @throws NativeIOException if there is an error with the syscall]]>
- </doc>
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fd" type="java.io.FileDescriptor"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="O_RDONLY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_WRONLY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_RDWR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_CREAT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_EXCL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_NOCTTY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_TRUNC" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_APPEND" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_NONBLOCK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_SYNC" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_ASYNC" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_FSYNC" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="O_NDELAY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_NORMAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_RANDOM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_SEQUENTIAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_WILLNEED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_DONTNEED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="POSIX_FADV_NOREUSE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SYNC_FILE_RANGE_WAIT_BEFORE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SYNC_FILE_RANGE_WRITE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SYNC_FILE_RANGE_WAIT_AFTER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[JNI wrappers for various native IO-related calls not available in Java.
- These functions should generally be used alongside a fallback to another
- more portable mechanism.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.nativeio.NativeIO -->
- <!-- start class org.apache.hadoop.io.nativeio.NativeIO.Stat -->
- <class name="NativeIO.Stat" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="S_IFMT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFIFO" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFCHR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFDIR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFBLK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFREG" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFLNK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFSOCK" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IFWHT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_ISUID" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_ISGID" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_ISVTX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IRUSR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IWUSR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="S_IXUSR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Result type of the fstat call]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.nativeio.NativeIO.Stat -->
- <!-- start class org.apache.hadoop.io.nativeio.NativeIOException -->
- <class name="NativeIOException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NativeIOException" type="java.lang.String, org.apache.hadoop.io.nativeio.Errno"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getErrno" return="org.apache.hadoop.io.nativeio.Errno"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[An exception generated by a call to the native IO code.
- These exceptions simply wrap <i>errno</i> result codes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.nativeio.NativeIOException -->
- </package>
- <package name="org.apache.hadoop.io.retry">
- <!-- start class org.apache.hadoop.io.retry.RetryPolicies -->
- <class name="RetryPolicies" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetryPolicies"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="retryUpToMaximumCountWithFixedSleep" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="maxRetries" type="int"/>
- <param name="sleepTime" type="long"/>
- <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[<p>
- Keep trying a limited number of times, waiting a fixed time between attempts,
- and then fail by re-throwing the exception.
- </p>]]>
- </doc>
- </method>
- <method name="retryUpToMaximumTimeWithFixedSleep" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="maxTime" type="long"/>
- <param name="sleepTime" type="long"/>
- <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[<p>
- Keep trying for a maximum time, waiting a fixed time between attempts,
- and then fail by re-throwing the exception.
- </p>]]>
- </doc>
- </method>
- <method name="retryUpToMaximumCountWithProportionalSleep" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="maxRetries" type="int"/>
- <param name="sleepTime" type="long"/>
- <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[<p>
- Keep trying a limited number of times, waiting a growing amount of time between attempts,
- and then fail by re-throwing the exception.
- The time between attempts is <code>sleepTime</code> mutliplied by the number of tries so far.
- </p>]]>
- </doc>
- </method>
- <method name="exponentialBackoffRetry" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="maxRetries" type="int"/>
- <param name="sleepTime" type="long"/>
- <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[<p>
- Keep trying a limited number of times, waiting a growing amount of time between attempts,
- and then fail by re-throwing the exception.
- The time between attempts is <code>sleepTime</code> mutliplied by a random
- number in the range of [0, 2 to the number of retries)
- </p>]]>
- </doc>
- </method>
- <method name="retryByException" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="defaultPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <param name="exceptionToPolicyMap" type="java.util.Map"/>
- <doc>
- <![CDATA[<p>
- Set a default policy with some explicit handlers for specific exceptions.
- </p>]]>
- </doc>
- </method>
- <method name="retryByRemoteException" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="defaultPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <param name="exceptionToPolicyMap" type="java.util.Map"/>
- <doc>
- <![CDATA[<p>
- A retry policy for RemoteException
- Set a default policy with some explicit handlers for specific exceptions.
- </p>]]>
- </doc>
- </method>
- <field name="TRY_ONCE_THEN_FAIL" type="org.apache.hadoop.io.retry.RetryPolicy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Try once, and fail by re-throwing the exception.
- This corresponds to having no retry mechanism in place.
- </p>]]>
- </doc>
- </field>
- <field name="TRY_ONCE_DONT_FAIL" type="org.apache.hadoop.io.retry.RetryPolicy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Try once, and fail silently for <code>void</code> methods, or by
- re-throwing the exception for non-<code>void</code> methods.
- </p>]]>
- </doc>
- </field>
- <field name="RETRY_FOREVER" type="org.apache.hadoop.io.retry.RetryPolicy"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Keep trying forever.
- </p>]]>
- </doc>
- </field>
- <doc>
- <![CDATA[<p>
- A collection of useful implementations of {@link RetryPolicy}.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.retry.RetryPolicies -->
- <!-- start class org.apache.hadoop.io.retry.RetryPolicies.MultipleLinearRandomRetry -->
- <class name="RetryPolicies.MultipleLinearRandomRetry" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.retry.RetryPolicy"/>
- <constructor name="RetryPolicies.MultipleLinearRandomRetry" type="java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="shouldRetry" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="e" type="java.lang.Exception"/>
- <param name="curRetry" type="int"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="parseCommaSeparatedString" return="org.apache.hadoop.io.retry.RetryPolicies.MultipleLinearRandomRetry"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Parse the given string as a MultipleLinearRandomRetry object.
- The format of the string is "t_1, n_1, t_2, n_2, ...",
- where t_i and n_i are the i-th pair of sleep time and number of retires.
- Note that the white spaces in the string are ignored.
- @return the parsed object, or null if the parsing fails.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Given pairs of number of retries and sleep time (n0, t0), (n1, t1), ...,
- the first n0 retries sleep t0 milliseconds on average,
- the following n1 retries sleep t1 milliseconds on average, and so on.
-
- For all the sleep, the actual sleep time is randomly uniform distributed
- in the close interval [0.5t, 1.5t], where t is the sleep time specified.
- The objects of this class are immutable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.retry.RetryPolicies.MultipleLinearRandomRetry -->
- <!-- start class org.apache.hadoop.io.retry.RetryPolicies.MultipleLinearRandomRetry.Pair -->
- <class name="RetryPolicies.MultipleLinearRandomRetry.Pair" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetryPolicies.MultipleLinearRandomRetry.Pair" type="int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Pairs of numRetries and sleepSeconds]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.retry.RetryPolicies.MultipleLinearRandomRetry.Pair -->
- <!-- start interface org.apache.hadoop.io.retry.RetryPolicy -->
- <interface name="RetryPolicy" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="shouldRetry" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="e" type="java.lang.Exception"/>
- <param name="retries" type="int"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[<p>
- Determines whether the framework should retry a
- method for the given exception, and the number
- of retries that have been made for that operation
- so far.
- </p>
- @param e The exception that caused the method to fail.
- @param retries The number of times the method has been retried.
- @return <code>true</code> if the method should be retried,
- <code>false</code> if the method should not be retried
- but shouldn't fail with an exception (only for void methods).
- @throws Exception The re-thrown exception <code>e</code> indicating
- that the method failed and should not be retried further.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- Specifies a policy for retrying method failures.
- Implementations of this interface should be immutable.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.retry.RetryPolicy -->
- <!-- start class org.apache.hadoop.io.retry.RetryProxy -->
- <class name="RetryProxy" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetryProxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="create" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="iface" type="java.lang.Class"/>
- <param name="implementation" type="java.lang.Object"/>
- <param name="retryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <doc>
- <![CDATA[<p>
- Create a proxy for an interface of an implementation class
- using the same retry policy for each method in the interface.
- </p>
- @param iface the interface that the retry will implement
- @param implementation the instance whose methods should be retried
- @param retryPolicy the policy for retirying method call failures
- @return the retry proxy]]>
- </doc>
- </method>
- <method name="create" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="iface" type="java.lang.Class"/>
- <param name="implementation" type="java.lang.Object"/>
- <param name="methodNameToPolicyMap" type="java.util.Map"/>
- <doc>
- <![CDATA[<p>
- Create a proxy for an interface of an implementation class
- using the a set of retry policies specified by method name.
- If no retry policy is defined for a method then a default of
- {@link RetryPolicies#TRY_ONCE_THEN_FAIL} is used.
- </p>
- @param iface the interface that the retry will implement
- @param implementation the instance whose methods should be retried
- @param methodNameToPolicyMap a map of method names to retry policies
- @return the retry proxy]]>
- </doc>
- </method>
- <method name="create" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="iface" type="java.lang.Class"/>
- <param name="implementation" type="java.lang.Object"/>
- <param name="defaultPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <param name="methodNameToPolicyMap" type="java.util.Map"/>
- </method>
- <doc>
- <![CDATA[<p>
- A factory for creating retry proxies.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.retry.RetryProxy -->
- <!-- start class org.apache.hadoop.io.retry.RetryUtils -->
- <class name="RetryUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetryUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getDefaultRetryPolicy" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="retryPolicyEnabledKey" type="java.lang.String"/>
- <param name="defaultRetryPolicyEnabled" type="boolean"/>
- <param name="retryPolicySpecKey" type="java.lang.String"/>
- <param name="defaultRetryPolicySpec" type="java.lang.String"/>
- <param name="remoteExceptionsToRetry" type="java.lang.Class[]"/>
- <doc>
- <![CDATA[Return the default retry policy set in conf.
-
- If the value retryPolicyEnabledKey is set to false in conf,
- use TRY_ONCE_THEN_FAIL.
-
- Otherwise, get the MultipleLinearRandomRetry policy specified in the conf
- and then
- (1) use multipleLinearRandomRetry for
- - remoteExceptionToRetry, or
- - IOException other than RemoteException; and
- (2) use TRY_ONCE_THEN_FAIL for
- - RemoteException other than remoteExceptionToRetry, or
- - non-IOException.
- @param conf
- @param retryPolicyEnabledKey conf property key for enabling retry
- @param defaultRetryPolicyEnabled default retryPolicyEnabledKey conf value
- @param retryPolicySpecKey conf property key for retry policy spec
- @param defaultRetryPolicySpec default retryPolicySpecKey conf value
- @param remoteExceptionsToRetry The particular RemoteExceptions to retry
- @return the default retry policy.]]>
- </doc>
- </method>
- <method name="getMultipleLinearRandomRetry" return="org.apache.hadoop.io.retry.RetryPolicy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="retryPolicyEnabledKey" type="java.lang.String"/>
- <param name="defaultRetryPolicyEnabled" type="boolean"/>
- <param name="retryPolicySpecKey" type="java.lang.String"/>
- <param name="defaultRetryPolicySpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Return the MultipleLinearRandomRetry policy specified in the conf,
- or null if the feature is disabled.
- If the policy is specified in the conf but the policy cannot be parsed,
- the default policy is returned.
-
- Retry policy spec:
- N pairs of sleep-time and number-of-retries "s1,n1,s2,n2,..."
-
- @param conf
- @param retryPolicyEnabledKey conf property key for enabling retry
- @param defaultRetryPolicyEnabled default retryPolicyEnabledKey conf value
- @param retryPolicySpecKey conf property key for retry policy spec
- @param defaultRetryPolicySpec default retryPolicySpecKey conf value
- @return the MultipleLinearRandomRetry policy specified in the conf,
- or null if the feature is disabled.]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.io.retry.RetryUtils -->
- </package>
- <package name="org.apache.hadoop.io.serializer">
- <!-- start interface org.apache.hadoop.io.serializer.Deserializer -->
- <interface name="Deserializer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="open"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Prepare the deserializer for reading.</p>]]>
- </doc>
- </method>
- <method name="deserialize" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- Deserialize the next object from the underlying input stream.
- If the object <code>t</code> is non-null then this deserializer
- <i>may</i> set its internal state to the next object read from the input
- stream. Otherwise, if the object <code>t</code> is null a new
- deserialized object will be created.
- </p>
- @return the deserialized object]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Close the underlying input stream and clear up any resources.</p>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- Provides a facility for deserializing objects of type <T> from an
- {@link InputStream}.
- </p>
-
- <p>
- Deserializers are stateful, but must not buffer the input since
- other producers may read from the input between calls to
- {@link #deserialize(Object)}.
- </p>
- @param <T>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.serializer.Deserializer -->
- <!-- start class org.apache.hadoop.io.serializer.DeserializerComparator -->
- <class name="DeserializerComparator" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.RawComparator"/>
- <constructor name="DeserializerComparator" type="org.apache.hadoop.io.serializer.Deserializer"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[<p>
- A {@link RawComparator} that uses a {@link Deserializer} to deserialize
- the objects to be compared so that the standard {@link Comparator} can
- be used to compare them.
- </p>
- <p>
- One may optimize compare-intensive operations by using a custom
- implementation of {@link RawComparator} that operates directly
- on byte representations.
- </p>
- @param <T>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.DeserializerComparator -->
- <!-- start class org.apache.hadoop.io.serializer.JavaSerialization -->
- <class name="JavaSerialization" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.serializer.Serialization"/>
- <constructor name="JavaSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <doc>
- <![CDATA[<p>
- An experimental {@link Serialization} for Java {@link Serializable} classes.
- </p>
- @see JavaSerializationComparator]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.JavaSerialization -->
- <!-- start class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
- <class name="JavaSerializationComparator" extends="org.apache.hadoop.io.serializer.DeserializerComparator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JavaSerializationComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o1" type="java.io.Serializable"/>
- <param name="o2" type="java.io.Serializable"/>
- </method>
- <doc>
- <![CDATA[<p>
- A {@link RawComparator} that uses a {@link JavaSerialization}
- {@link Deserializer} to deserialize objects that are then compared via
- their {@link Comparable} interfaces.
- </p>
- @param <T>
- @see JavaSerialization]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
- <!-- start interface org.apache.hadoop.io.serializer.Serialization -->
- <interface name="Serialization" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[Allows clients to test whether this {@link Serialization}
- supports the given class.]]>
- </doc>
- </method>
- <method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[@return a {@link Serializer} for the given class.]]>
- </doc>
- </method>
- <method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <doc>
- <![CDATA[@return a {@link Deserializer} for the given class.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- Encapsulates a {@link Serializer}/{@link Deserializer} pair.
- </p>
- @param <T>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.serializer.Serialization -->
- <!-- start class org.apache.hadoop.io.serializer.SerializationFactory -->
- <class name="SerializationFactory" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SerializationFactory" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Serializations are found by reading the <code>io.serializations</code>
- property from <code>conf</code>, which is a comma-delimited list of
- classnames.
- </p>]]>
- </doc>
- </constructor>
- <method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getSerialization" return="org.apache.hadoop.io.serializer.Serialization"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <doc>
- <![CDATA[<p>
- A factory for {@link Serialization}s.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.SerializationFactory -->
- <!-- start interface org.apache.hadoop.io.serializer.Serializer -->
- <interface name="Serializer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="open"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Prepare the serializer for writing.</p>]]>
- </doc>
- </method>
- <method name="serialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Serialize <code>t</code> to the underlying output stream.</p>]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>Close the underlying output stream and clear up any resources.</p>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- Provides a facility for serializing objects of type <T> to an
- {@link OutputStream}.
- </p>
-
- <p>
- Serializers are stateful, but must not buffer the output since
- other producers may write to the output between calls to
- {@link #serialize(Object)}.
- </p>
- @param <T>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.io.serializer.Serializer -->
- <!-- start class org.apache.hadoop.io.serializer.WritableSerialization -->
- <class name="WritableSerialization" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.serializer.Serialization"/>
- <constructor name="WritableSerialization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- </method>
- <doc>
- <![CDATA[A {@link Serialization} for {@link Writable}s that delegates to
- {@link Writable#write(java.io.DataOutput)} and
- {@link Writable#readFields(java.io.DataInput)}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.io.serializer.WritableSerialization -->
- </package>
- <package name="org.apache.hadoop.ipc">
- <!-- start class org.apache.hadoop.ipc.Client -->
- <class name="Client" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Client" type="java.lang.Class, org.apache.hadoop.conf.Configuration, javax.net.SocketFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an IPC client whose values are of the given {@link Writable}
- class.]]>
- </doc>
- </constructor>
- <constructor name="Client" type="java.lang.Class, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an IPC client with the default SocketFactory
- @param valueClass
- @param conf]]>
- </doc>
- </constructor>
- <method name="setPingInterval"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="pingInterval" type="int"/>
- <doc>
- <![CDATA[set the ping interval value in configuration
-
- @param conf Configuration
- @param pingInterval the ping interval]]>
- </doc>
- </method>
- <method name="getTimeout" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[The time after which a RPC will timeout. If ping is not enabled (via
- ipc.client.ping), then the timeout value is the same as the pingInterval.
- If ping is enabled, then there is no timeout value.
-
- @param conf Configuration
- @return the timeout period in milliseconds. -1 if no timeout value is set]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop all threads related to this client. No further calls may be made
- using this client.]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Writable, ConnectionId)} instead">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="address" type="java.net.InetSocketAddress"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a call, passing <code>param</code>, to the IPC server running at
- <code>address</code>, returning the value. Throws exceptions if there are
- network problems or if the remote code threw an exception.
- @deprecated Use {@link #call(Writable, ConnectionId)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Writable, ConnectionId)} instead">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a call, passing <code>param</code>, to the IPC server running at
- <code>address</code> with the <code>ticket</code> credentials, returning
- the value.
- Throws exceptions if there are network problems or if the remote code
- threw an exception.
- @deprecated Use {@link #call(Writable, ConnectionId)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Writable, ConnectionId)} instead">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="rpcTimeout" type="int"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a call, passing <code>param</code>, to the IPC server running at
- <code>address</code> which is servicing the <code>protocol</code> protocol,
- with the <code>ticket</code> credentials and <code>rpcTimeout</code> as
- timeout, returning the value.
- Throws exceptions if there are network problems or if the remote code
- threw an exception.
- @deprecated Use {@link #call(Writable, ConnectionId)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="rpcTimeout" type="int"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a call, passing <code>param</code>, to the IPC server running at
- <code>address</code> which is servicing the <code>protocol</code> protocol,
- with the <code>ticket</code> credentials, <code>rpcTimeout</code> as timeout
- and <code>conf</code> as configuration for this connection, returning the
- value. Throws exceptions if there are network problems or if the remote code
- threw an exception.]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="remoteId" type="org.apache.hadoop.ipc.Client.ConnectionId"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a call, passing <code>param</code>, to the IPC server defined by
- <code>remoteId</code>, returning the value.
- Throws exceptions if there are network problems or if the remote code
- threw an exception.]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Writable[], InetSocketAddress[],
- Class, UserGroupInformation, Configuration)} instead">
- <param name="params" type="org.apache.hadoop.io.Writable[]"/>
- <param name="addresses" type="java.net.InetSocketAddress[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[@deprecated Use {@link #call(Writable[], InetSocketAddress[],
- Class, UserGroupInformation, Configuration)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Writable[], InetSocketAddress[],
- Class, UserGroupInformation, Configuration)} instead">
- <param name="params" type="org.apache.hadoop.io.Writable[]"/>
- <param name="addresses" type="java.net.InetSocketAddress[]"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[@deprecated Use {@link #call(Writable[], InetSocketAddress[],
- Class, UserGroupInformation, Configuration)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="params" type="org.apache.hadoop.io.Writable[]"/>
- <param name="addresses" type="java.net.InetSocketAddress[]"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Makes a set of calls in parallel. Each parameter is sent to the
- corresponding address. When all values are available, or have timed out
- or errored, the collected results are returned in an array. The array
- contains nulls for calls that timed out or errored.]]>
- </doc>
- </method>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A client for an IPC service. IPC calls take a single {@link Writable} as a
- parameter, and return a {@link Writable} as their value. A service runs on
- a port and is defined by a parameter class and a value class.
-
- @see Server]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.Client -->
- <!-- start class org.apache.hadoop.ipc.RemoteException -->
- <class name="RemoteException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RemoteException" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="unwrapRemoteException" return="java.io.IOException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lookupTypes" type="java.lang.Class[]"/>
- <doc>
- <![CDATA[If this remote exception wraps up one of the lookupTypes
- then return this exception.
- <p>
- Unwraps any IOException.
-
- @param lookupTypes the desired exception class.
- @return IOException, which is either the lookupClass exception or this.]]>
- </doc>
- </method>
- <method name="unwrapRemoteException" return="java.io.IOException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Instantiate and return the exception wrapped up by this remote exception.
-
- <p> This unwraps any <code>Throwable</code> that has a constructor taking
- a <code>String</code> as a parameter.
- Otherwise it returns this.
-
- @return <code>Throwable]]>
- </doc>
- </method>
- <method name="valueOf" return="org.apache.hadoop.ipc.RemoteException"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attrs" type="org.xml.sax.Attributes"/>
- <doc>
- <![CDATA[Create RemoteException from attributes]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.ipc.RemoteException -->
- <!-- start class org.apache.hadoop.ipc.RPC -->
- <class name="RPC" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="waitForProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="factory" type="javax.net.SocketFactory"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object that implements the named protocol,
- talking to a server at the named address.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="factory" type="javax.net.SocketFactory"/>
- <param name="rpcTimeout" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object that implements the named protocol,
- talking to a server at the named address.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="factory" type="javax.net.SocketFactory"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object that implements the named protocol,
- talking to a server at the named address.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="factory" type="javax.net.SocketFactory"/>
- <param name="rpcTimeout" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object that implements the named protocol,
- talking to a server at the named address.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="factory" type="javax.net.SocketFactory"/>
- <param name="rpcTimeout" type="int"/>
- <param name="connectionRetryPolicy" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <param name="checkVersion" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object that implements the named protocol,
- talking to a server at the named address.]]>
- </doc>
- </method>
- <method name="checkVersion"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="proxy" type="org.apache.hadoop.ipc.VersionedProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get server version and then compare it with client version.]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a client-side proxy object with the default SocketFactory
-
- @param protocol
- @param clientVersion
- @param addr
- @param conf
- @return a proxy instance
- @throws IOException]]>
- </doc>
- </method>
- <method name="getProxy" return="org.apache.hadoop.ipc.VersionedProtocol"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="clientVersion" type="long"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="rpcTimeout" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="stopProxy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="proxy" type="org.apache.hadoop.ipc.VersionedProtocol"/>
- <doc>
- <![CDATA[Stop this proxy and release its invoker's resource
- @param proxy the proxy to be stopped]]>
- </doc>
- </method>
- <method name="call" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #call(Method, Object[][], InetSocketAddress[], UserGroupInformation, Configuration)} instead">
- <param name="method" type="java.lang.reflect.Method"/>
- <param name="params" type="java.lang.Object[][]"/>
- <param name="addrs" type="java.net.InetSocketAddress[]"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Expert: Make multiple, parallel calls to a set of servers.
- @deprecated Use {@link #call(Method, Object[][], InetSocketAddress[], UserGroupInformation, Configuration)} instead]]>
- </doc>
- </method>
- <method name="call" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="method" type="java.lang.reflect.Method"/>
- <param name="params" type="java.lang.Object[][]"/>
- <param name="addrs" type="java.net.InetSocketAddress[]"/>
- <param name="ticket" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Expert: Make multiple, parallel calls to a set of servers.]]>
- </doc>
- </method>
- <method name="getServer" return="org.apache.hadoop.ipc.RPC.Server"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="instance" type="java.lang.Object"/>
- <param name="bindAddress" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a server for a protocol implementation instance listening on a
- port and address.]]>
- </doc>
- </method>
- <method name="getServer" return="org.apache.hadoop.ipc.RPC.Server"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="instance" type="java.lang.Object"/>
- <param name="bindAddress" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="numHandlers" type="int"/>
- <param name="verbose" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a server for a protocol implementation instance listening on a
- port and address.]]>
- </doc>
- </method>
- <method name="getServer" return="org.apache.hadoop.ipc.RPC.Server"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="instance" type="java.lang.Object"/>
- <param name="bindAddress" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="numHandlers" type="int"/>
- <param name="verbose" type="boolean"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="secretManager" type="org.apache.hadoop.security.token.SecretManager"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a server for a protocol implementation instance listening on a
- port and address, with a secret manager.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A simple RPC mechanism.
- A <i>protocol</i> is a Java interface. All parameters and return types must
- be one of:
- <ul> <li>a primitive type, <code>boolean</code>, <code>byte</code>,
- <code>char</code>, <code>short</code>, <code>int</code>, <code>long</code>,
- <code>float</code>, <code>double</code>, or <code>void</code>; or</li>
- <li>a {@link String}; or</li>
- <li>a {@link Writable}; or</li>
- <li>an array of the above types</li> </ul>
- All methods in the protocol should throw only IOException. No field data of
- the protocol instance is transmitted.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.RPC -->
- <!-- start class org.apache.hadoop.ipc.RPC.Server -->
- <class name="RPC.Server" extends="org.apache.hadoop.ipc.Server"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RPC.Server" type="java.lang.Object, org.apache.hadoop.conf.Configuration, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct an RPC server.
- @param instance the instance whose methods will be called
- @param conf the configuration to use
- @param bindAddress the address to bind on to listen for connection
- @param port the port to listen for connections on]]>
- </doc>
- </constructor>
- <constructor name="RPC.Server" type="java.lang.Object, org.apache.hadoop.conf.Configuration, java.lang.String, int, int, boolean, org.apache.hadoop.security.token.SecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct an RPC server.
- @param instance the instance whose methods will be called
- @param conf the configuration to use
- @param bindAddress the address to bind on to listen for connection
- @param port the port to listen for connections on
- @param numHandlers the number of method handler threads to run
- @param verbose whether each call should be logged]]>
- </doc>
- </constructor>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="receivedTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An RPC Server.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.RPC.Server -->
- <!-- start class org.apache.hadoop.ipc.RPC.VersionMismatch -->
- <class name="RPC.VersionMismatch" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RPC.VersionMismatch" type="java.lang.String, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a version mismatch exception
- @param interfaceName the name of the protocol mismatch
- @param clientVersion the client's version of the protocol
- @param serverVersion the server's version of the protocol]]>
- </doc>
- </constructor>
- <method name="getInterfaceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the interface name
- @return the java class name
- (eg. org.apache.hadoop.mapred.InterTrackerProtocol)]]>
- </doc>
- </method>
- <method name="getClientVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the client's preferred version]]>
- </doc>
- </method>
- <method name="getServerVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the server's agreed to version.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A version mismatch for the RPC protocol.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.RPC.VersionMismatch -->
- <!-- start class org.apache.hadoop.ipc.Server -->
- <class name="Server" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Server" type="java.lang.String, int, java.lang.Class, int, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="Server" type="java.lang.String, int, java.lang.Class, int, org.apache.hadoop.conf.Configuration, java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="Server" type="java.lang.String, int, java.lang.Class, int, org.apache.hadoop.conf.Configuration, java.lang.String, org.apache.hadoop.security.token.SecretManager"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs a server listening on the named port and address. Parameters passed must
- be of the named class. The <code>handlerCount</handlerCount> determines
- the number of handler threads that will be used to process calls.]]>
- </doc>
- </constructor>
- <method name="addTerseExceptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="exceptionClass" type="java.lang.Class[]"/>
- </method>
- <method name="get" return="org.apache.hadoop.ipc.Server"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the server instance called under or null. May be called under
- {@link #call(Writable, long)} implementations, and under {@link Writable}
- methods of paramters and return values. Permits applications to access
- the server context.]]>
- </doc>
- </method>
- <method name="getRemoteIp" return="java.net.InetAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the remote side ip address when invoked inside an RPC
- Returns null incase of an error.]]>
- </doc>
- </method>
- <method name="getRemoteAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns remote address as a string when invoked inside an RPC.
- Returns null in case of an error.]]>
- </doc>
- </method>
- <method name="bind"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.ServerSocket"/>
- <param name="address" type="java.net.InetSocketAddress"/>
- <param name="backlog" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A convenience method to bind to a given address and report
- better exceptions if the address is not a valid host.
- @param socket the socket to bind
- @param address the address to bind to
- @param backlog the number of connections allowed in the queue
- @throws BindException if the address can't be bound
- @throws UnknownHostException if the address isn't a valid host name
- @throws IOException other random errors from bind]]>
- </doc>
- </method>
- <method name="getRpcMetrics" return="org.apache.hadoop.ipc.metrics.RpcInstrumentation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a handle to the rpcMetrics (required in tests)
- @return rpc metrics]]>
- </doc>
- </method>
- <method name="setSocketSendBufSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="int"/>
- <doc>
- <![CDATA[Sets the socket buffer size used for responding to RPCs]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Starts the service. Must be called before any calls will be handled.]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops the service. No new calls will be handled after this is called.]]>
- </doc>
- </method>
- <method name="join"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Wait for the server to be stopped.
- Does not wait for all subthreads to finish.
- See {@link #stop()}.]]>
- </doc>
- </method>
- <method name="getListenerAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the socket (ip+port) on which the RPC server is listening to.
- @return the socket (ip+port) on which the RPC server is listening to.]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #call(Class, Writable, long)} instead">
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="receiveTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called for each call.
- @deprecated Use {@link #call(Class, Writable, long)} instead]]>
- </doc>
- </method>
- <method name="call" return="org.apache.hadoop.io.Writable"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.Class"/>
- <param name="param" type="org.apache.hadoop.io.Writable"/>
- <param name="receiveTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called for each call.]]>
- </doc>
- </method>
- <method name="authorize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="connection" type="org.apache.hadoop.ipc.ConnectionHeader"/>
- <param name="addr" type="java.net.InetAddress"/>
- <exception name="AuthorizationException" type="org.apache.hadoop.security.authorize.AuthorizationException"/>
- <doc>
- <![CDATA[Authorize the incoming client connection.
-
- @param user client user
- @param connection incoming connection
- @param addr InetAddress of incoming connection
- @throws AuthorizationException when the client isn't authorized to talk the protocol]]>
- </doc>
- </method>
- <method name="getNumOpenConnections" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of open RPC conections
- @return the number of open rpc connections]]>
- </doc>
- </method>
- <method name="getCallQueueLen" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of rpc calls in the queue.
- @return The number of rpc calls in the queue.]]>
- </doc>
- </method>
- <field name="HEADER" type="java.nio.ByteBuffer"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The first four bytes of Hadoop RPC connections]]>
- </doc>
- </field>
- <field name="CURRENT_VERSION" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="rpcMetrics" type="org.apache.hadoop.ipc.metrics.RpcInstrumentation"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An abstract IPC service. IPC calls take a single {@link Writable} as a
- parameter, and return a {@link Writable} as their value. A service runs on
- a port and is defined by a parameter class and a value class.
-
- @see Client]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.Server -->
- <!-- start class org.apache.hadoop.ipc.Server.Connection -->
- <class name="Server.Connection" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Server.Connection" type="java.nio.channels.SelectionKey, java.nio.channels.SocketChannel, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHostAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHostInetAddress" return="java.net.InetAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setLastContact"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lastContact" type="long"/>
- </method>
- <method name="getLastContact" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readAndProcess" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="attemptingUser" type="org.apache.hadoop.security.UserGroupInformation"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Reads calls from a connection and queues them for handling.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.Server.Connection -->
- <!-- start interface org.apache.hadoop.ipc.VersionedProtocol -->
- <interface name="VersionedProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getProtocolVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.String"/>
- <param name="clientVersion" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return protocol version corresponding to protocol interface.
- @param protocol The classname of the protocol interface
- @param clientVersion The version of the protocol that the client speaks
- @return the version that the server will speak]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Superclass of all protocols that use Hadoop RPC.
- Subclasses of this interface are also supposed to have
- a static final long versionID field.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.ipc.VersionedProtocol -->
- </package>
- <package name="org.apache.hadoop.ipc.metrics">
- <!-- start class org.apache.hadoop.ipc.metrics.RpcInstrumentation -->
- <class name="RpcInstrumentation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSource"/>
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="create" return="org.apache.hadoop.ipc.metrics.RpcInstrumentation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serverName" type="java.lang.String"/>
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Create an RPC instrumentation object
- @param serverName name of the server
- @param port the RPC port
- @return the instrumentation object]]>
- </doc>
- </method>
- <method name="create" return="org.apache.hadoop.ipc.metrics.RpcInstrumentation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serverName" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="ms" type="org.apache.hadoop.metrics2.MetricsSystem"/>
- <doc>
- <![CDATA[Create an RPC instrumentation object
- Mostly useful for testing.
- @param serverName name of the server
- @param port the RPC port
- @param ms the metrics system object
- @return the instrumentation object]]>
- </doc>
- </method>
- <method name="detailed" return="org.apache.hadoop.metrics2.MetricsSource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the detailed (per call) metrics source for RPC]]>
- </doc>
- </method>
- <method name="incrAuthenticationFailures"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[One authentication failure event]]>
- </doc>
- </method>
- <method name="incrAuthenticationSuccesses"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[One authentication success event]]>
- </doc>
- </method>
- <method name="incrAuthorizationSuccesses"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[One authorization success event]]>
- </doc>
- </method>
- <method name="incrAuthorizationFailures"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[One authorization failure event]]>
- </doc>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Shutdown the instrumentation for the process]]>
- </doc>
- </method>
- <method name="incrSentBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[Increment sent bytes by count
- @param count to increment]]>
- </doc>
- </method>
- <method name="incrReceivedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="count" type="int"/>
- <doc>
- <![CDATA[Increment received bytes by count
- @param count to increment]]>
- </doc>
- </method>
- <method name="addRpcQueueTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qTime" type="int"/>
- <doc>
- <![CDATA[Add an RPC queue time sample
- @param qTime]]>
- </doc>
- </method>
- <method name="addRpcProcessingTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="processingTime" type="int"/>
- <doc>
- <![CDATA[Add an RPC processing time sample
- @param processingTime]]>
- </doc>
- </method>
- <method name="addRpcProcessingTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="methodName" type="java.lang.String"/>
- <param name="processingTime" type="int"/>
- <doc>
- <![CDATA[Add an RPC processing time sample for a particular RPC method
- @param methodName method name of the RPC
- @param processingTime elapsed processing time of the RPC]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The RPC metrics instrumentation]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.metrics.RpcInstrumentation -->
- <!-- start class org.apache.hadoop.ipc.metrics.RpcInstrumentation.Detailed -->
- <class name="RpcInstrumentation.Detailed" extends="org.apache.hadoop.metrics2.lib.AbstractMetricsSource"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="addRpcProcessingTime"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="methodName" type="java.lang.String"/>
- <param name="processingTime" type="int"/>
- </method>
- <doc>
- <![CDATA[Use a separate source for detailed (per call) RPC metrics for
- easy and efficient filtering]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.ipc.metrics.RpcInstrumentation.Detailed -->
- </package>
- <package name="org.apache.hadoop.jmx">
- <!-- start class org.apache.hadoop.jmx.JMXJsonServlet -->
- <class name="JMXJsonServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JMXJsonServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Initialize this servlet.]]>
- </doc>
- </method>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <doc>
- <![CDATA[Process a GET request for the specified resource.
-
- @param request
- The servlet request we are processing
- @param response
- The servlet response we are creating]]>
- </doc>
- </method>
- <field name="mBeanServer" type="javax.management.MBeanServer"
- transient="true" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[MBean server.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Provides Read only web access to JMX.
- <p>
- This servlet generally will be placed under the /jmx URL for each
- HttpServer. It provides read only
- access to JMX metrics. The optional <code>qry</code> parameter
- may be used to query only a subset of the JMX Beans. This query
- functionality is provided through the
- {@link MBeanServer#queryNames(ObjectName, javax.management.QueryExp)}
- method.
- <p>
- For example <code>http://.../jmx?qry=Hadoop:*</code> will return
- all hadoop metrics exposed through JMX.
- <p>
- If the <code>qry</code> parameter is not formatted correctly then a
- 400 BAD REQUEST http response code will be returned.
- <p>
- The return format is JSON and in the form
- <p>
- <code><pre>
- {
- "beans" : [
- {
- "name":"bean-name"
- ...
- }
- ]
- }
- </pre></code>
- <p>
- The servlet attempts to convert the the JMXBeans into JSON. Each
- bean's attributes will be converted to a JSON object member.
-
- If the attribute is a boolean, a number, a string, or an array
- it will be converted to the JSON equivalent.
-
- If the value is a {@link CompositeData} then it will be converted
- to a JSON object with the keys as the name of the JSON member and
- the value is converted following these same rules.
-
- If the value is a {@link TabularData} then it will be converted
- to an array of the {@link CompositeData} elements that it contains.
-
- All other objects will be converted to a string and output as such.
-
- The bean's name and modelerType will be returned for all beans.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.jmx.JMXJsonServlet -->
- </package>
- <package name="org.apache.hadoop.log">
- <!-- start class org.apache.hadoop.log.EventCounter -->
- <class name="EventCounter" extends="org.apache.hadoop.log.metrics.EventCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link org.apache.hadoop.log.metrics.EventCounter} instead">
- <constructor name="EventCounter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A log4J Appender that simply counts logging events in three levels:
- fatal, error and warn. The class name is used in log4j.properties
- @deprecated use {@link org.apache.hadoop.log.metrics.EventCounter} instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.log.EventCounter -->
- <!-- start class org.apache.hadoop.log.LogLevel -->
- <class name="LogLevel" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LogLevel"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[A command line implementation]]>
- </doc>
- </method>
- <field name="USAGES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Change log level in runtime.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.log.LogLevel -->
- <!-- start class org.apache.hadoop.log.LogLevel.Servlet -->
- <class name="LogLevel.Servlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LogLevel.Servlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A servlet implementation]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.log.LogLevel.Servlet -->
- </package>
- <package name="org.apache.hadoop.log.metrics">
- <!-- start class org.apache.hadoop.log.metrics.EventCounter -->
- <class name="EventCounter" extends="org.apache.log4j.AppenderSkeleton"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="EventCounter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getFatal" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getError" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getWarn" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInfo" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="requiresLayout" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A log4J Appender that simply counts logging events in three levels:
- fatal, error and warn. The class name is used in log4j.properties]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.log.metrics.EventCounter -->
- </package>
- <package name="org.apache.hadoop.metrics">
- <!-- start class org.apache.hadoop.metrics.ContextFactory -->
- <class name="ContextFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="ContextFactory"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of ContextFactory]]>
- </doc>
- </constructor>
- <method name="getAttribute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the value of the named attribute, or null if there is no
- attribute of that name.
- @param attributeName the attribute name
- @return the attribute value]]>
- </doc>
- </method>
- <method name="getAttributeNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the names of all the factory's attributes.
-
- @return the attribute names]]>
- </doc>
- </method>
- <method name="setAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Sets the named factory attribute to the specified value, creating it
- if it did not already exist. If the value is null, this is the same as
- calling removeAttribute.
- @param attributeName the attribute name
- @param value the new attribute value]]>
- </doc>
- </method>
- <method name="removeAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes the named attribute if it exists.
- @param attributeName the attribute name]]>
- </doc>
- </method>
- <method name="getContext" return="org.apache.hadoop.metrics.MetricsContext"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="refName" type="java.lang.String"/>
- <param name="contextName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InstantiationException" type="java.lang.InstantiationException"/>
- <exception name="IllegalAccessException" type="java.lang.IllegalAccessException"/>
- <doc>
- <![CDATA[Returns the named MetricsContext instance, constructing it if necessary
- using the factory's current configuration attributes. <p/>
-
- When constructing the instance, if the factory property
- <i>contextName</i>.class</code> exists,
- its value is taken to be the name of the class to instantiate. Otherwise,
- the default is to create an instance of
- <code>org.apache.hadoop.metrics.spi.NullContext</code>, which is a
- dummy "no-op" context which will cause all metric data to be discarded.
-
- @param contextName the name of the context
- @return the named MetricsContext]]>
- </doc>
- </method>
- <method name="getContext" return="org.apache.hadoop.metrics.MetricsContext"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InstantiationException" type="java.lang.InstantiationException"/>
- <exception name="IllegalAccessException" type="java.lang.IllegalAccessException"/>
- </method>
- <method name="getAllContexts" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns all MetricsContexts built by this factory.]]>
- </doc>
- </method>
- <method name="getNullContext" return="org.apache.hadoop.metrics.MetricsContext"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a "null" context - one which does nothing.]]>
- </doc>
- </method>
- <method name="getFactory" return="org.apache.hadoop.metrics.ContextFactory"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the singleton ContextFactory instance, constructing it if
- necessary. <p/>
-
- When the instance is constructed, this method checks if the file
- <code>hadoop-metrics.properties</code> exists on the class path. If it
- exists, it must be in the format defined by java.util.Properties, and all
- the properties in the file are set as attributes on the newly created
- ContextFactory instance.
- @return the singleton ContextFactory instance]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Factory class for creating MetricsContext objects. To obtain an instance
- of this class, use the static <code>getFactory()</code> method.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.ContextFactory -->
- <!-- start interface org.apache.hadoop.metrics.MetricsContext -->
- <interface name="MetricsContext" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- <doc>
- <![CDATA[Initialize this context.
- @param contextName The given name for this context
- @param factory The creator of this context]]>
- </doc>
- </method>
- <method name="getContextName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the context name.
- @return the context name]]>
- </doc>
- </method>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts or restarts monitoring, the emitting of metrics records as they are
- updated.]]>
- </doc>
- </method>
- <method name="stopMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring. This does not free any data that the implementation
- may have buffered for sending at the next timer event. It
- is OK to call <code>startMonitoring()</code> again after calling
- this.
- @see #close()]]>
- </doc>
- </method>
- <method name="isMonitoring" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if monitoring is currently in progress.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring and also frees any buffered data, returning this
- object to its initial state.]]>
- </doc>
- </method>
- <method name="createRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Creates a new MetricsRecord instance with the given <code>recordName</code>.
- Throws an exception if the metrics implementation is configured with a fixed
- set of record names and <code>recordName</code> is not in that set.
- @param recordName the name of the record
- @throws MetricsException if recordName conflicts with configuration data]]>
- </doc>
- </method>
- <method name="registerUpdater"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Registers a callback to be called at regular time intervals, as
- determined by the implementation-class specific configuration.
- @param updater object to be run periodically; it should updated
- some metrics records and then return]]>
- </doc>
- </method>
- <method name="unregisterUpdater"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Removes a callback, if it exists.
-
- @param updater object to be removed from the callback list]]>
- </doc>
- </method>
- <method name="getPeriod" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the timer period.]]>
- </doc>
- </method>
- <method name="getAllRecords" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieves all the records managed by this MetricsContext.
- Useful for monitoring systems that are polling-based.
-
- @return A non-null map from all record names to the records managed.]]>
- </doc>
- </method>
- <field name="DEFAULT_PERIOD" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default period in seconds at which data is sent to the metrics system.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The main interface to the metrics package.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics.MetricsContext -->
- <!-- start class org.apache.hadoop.metrics.MetricsException -->
- <class name="MetricsException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.MetricsException}.">
- <constructor name="MetricsException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of MetricsException]]>
- </doc>
- </constructor>
- <constructor name="MetricsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of MetricsException
- @param message an error message]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[General-purpose, unchecked metrics exception.
- @deprecated in favor of {@link org.apache.hadoop.metrics2.MetricsException}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.MetricsException -->
- <!-- start interface org.apache.hadoop.metrics.MetricsRecord -->
- <interface name="MetricsRecord" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <method name="getRecordName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the record name.
- @return the record name]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value. The tagValue may be null,
- which is treated the same as an empty String.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="int"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="long"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="short"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="removeTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes any tag of the specified name.
- @param tagName name of a tag]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Updates the table of buffered data which is to be sent periodically.
- If the tag values match an existing row, that row is updated;
- otherwise, a new row is added.]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Removes, from the buffered data table, all rows having tags
- that equal the tags that have been set on this record. For example,
- if there are no tags on this record, all rows for this record name
- would be removed. Or, if there is a single tag on this record, then
- just rows containing a tag with the same name and value would be removed.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A named and optionally tagged set of records to be sent to the metrics
- system. <p/>
- A record name identifies the kind of data to be reported. For example, a
- program reporting statistics relating to the disks on a computer might use
- a record name "diskStats".<p/>
- A record has zero or more <i>tags</i>. A tag has a name and a value. To
- continue the example, the "diskStats" record might use a tag named
- "diskName" to identify a particular disk. Sometimes it is useful to have
- more than one tag, so there might also be a "diskType" with value "ide" or
- "scsi" or whatever.<p/>
- A record also has zero or more <i>metrics</i>. These are the named
- values that are to be reported to the metrics system. In the "diskStats"
- example, possible metric names would be "diskPercentFull", "diskPercentBusy",
- "kbReadPerSecond", etc.<p/>
-
- The general procedure for using a MetricsRecord is to fill in its tag and
- metric values, and then call <code>update()</code> to pass the record to the
- client library.
- Metric data is not immediately sent to the metrics system
- each time that <code>update()</code> is called.
- An internal table is maintained, identified by the record name. This
- table has columns
- corresponding to the tag and the metric names, and rows
- corresponding to each unique set of tag values. An update
- either modifies an existing row in the table, or adds a new row with a set of
- tag values that are different from all the other rows. Note that if there
- are no tags, then there can be at most one row in the table. <p/>
-
- Once a row is added to the table, its data will be sent to the metrics system
- on every timer period, whether or not it has been updated since the previous
- timer period. If this is inappropriate, for example if metrics were being
- reported by some transient object in an application, the <code>remove()</code>
- method can be used to remove the row and thus stop the data from being
- sent.<p/>
- Note that the <code>update()</code> method is atomic. This means that it is
- safe for different threads to be updating the same metric. More precisely,
- it is OK for different threads to call <code>update()</code> on MetricsRecord instances
- with the same set of tag names and tag values. Different threads should
- <b>not</b> use the same MetricsRecord instance at the same time.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics.MetricsRecord -->
- <!-- start class org.apache.hadoop.metrics.MetricsServlet -->
- <class name="MetricsServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="MetricsServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A servlet to print out metrics data. By default, the servlet returns a
- textual representation (no promises are made for parseability), and
- users can use "?format=json" for parseable output.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.MetricsServlet -->
- <!-- start class org.apache.hadoop.metrics.MetricsUtil -->
- <class name="MetricsUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <method name="getContext" return="org.apache.hadoop.metrics.MetricsContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- </method>
- <method name="getContext" return="org.apache.hadoop.metrics.MetricsContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="refName" type="java.lang.String"/>
- <param name="contextName" type="java.lang.String"/>
- <doc>
- <![CDATA[Utility method to return the named context.
- If the desired context cannot be created for any reason, the exception
- is logged, and a null context is returned.]]>
- </doc>
- </method>
- <method name="createRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.metrics.MetricsContext"/>
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Utility method to create and return new metrics record instance within the
- given context. This record is tagged with the host name.
- @param context the context
- @param recordName name of the record
- @return newly created metrics record]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Utility class to simplify creation and reporting of hadoop metrics.
- For examples of usage, see NameNodeMetrics.
- @see org.apache.hadoop.metrics.MetricsRecord
- @see org.apache.hadoop.metrics.MetricsContext
- @see org.apache.hadoop.metrics.ContextFactory
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.MetricsUtil -->
- <!-- start interface org.apache.hadoop.metrics.Updater -->
- <interface name="Updater" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <method name="doUpdates"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.metrics.MetricsContext"/>
- <doc>
- <![CDATA[Timer-based call-back from the metric library.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Call-back interface. See <code>MetricsContext.registerUpdater()</code>.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics.Updater -->
- </package>
- <package name="org.apache.hadoop.metrics.file">
- <!-- start class org.apache.hadoop.metrics.file.FileContext -->
- <class name="FileContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link org.apache.hadoop.metrics2.sink.FileSink} instead.">
- <constructor name="FileContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of FileContext]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="getFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the configured file name, or null.]]>
- </doc>
- </method>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts or restarts monitoring, by opening in append-mode, the
- file specified by the <code>fileName</code> attribute,
- if specified. Otherwise the data will be written to standard
- output.]]>
- </doc>
- </method>
- <method name="stopMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring, closing the file.
- @see #close()]]>
- </doc>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <doc>
- <![CDATA[Emits a metrics record to a file.]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flushes the output writer, forcing updates to disk.]]>
- </doc>
- </method>
- <field name="FILE_NAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="PERIOD_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Metrics context for writing metrics to a file.<p/>
- This class is configured by setting ContextFactory attributes which in turn
- are usually configured through a properties file. All the attributes are
- prefixed by the contextName. For example, the properties file might contain:
- <pre>
- myContextName.fileName=/tmp/metrics.log
- myContextName.period=5
- </pre>
- @deprecated use {@link org.apache.hadoop.metrics2.sink.FileSink} instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.file.FileContext -->
- </package>
- <package name="org.apache.hadoop.metrics.ganglia">
- <!-- start class org.apache.hadoop.metrics.ganglia.GangliaContext -->
- <class name="GangliaContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="GangliaContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of GangliaContext]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="emitMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="type" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUnits" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getSlope" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getTmax" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="getDmax" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- </method>
- <method name="xdr_string"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Puts a string into the buffer by first writing the size of the string
- as an int, followed by the bytes of the string, padded if necessary to
- a multiple of 4.]]>
- </doc>
- </method>
- <method name="xdr_int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Puts an integer into the buffer as 4 bytes, big-endian.]]>
- </doc>
- </method>
- <field name="buffer" type="byte[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="offset" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="metricsServers" type="java.util.List"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="datagramSocket" type="java.net.DatagramSocket"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Context for sending metrics to Ganglia.
-
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.ganglia.GangliaContext -->
- <!-- start class org.apache.hadoop.metrics.ganglia.GangliaContext31 -->
- <class name="GangliaContext31" extends="org.apache.hadoop.metrics.ganglia.GangliaContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GangliaContext31"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="emitMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="type" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Context for sending metrics to Ganglia version 3.1.x.
-
- 3.1.1 has a slightly different wire portal compared to 3.0.x.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.ganglia.GangliaContext31 -->
- </package>
- <package name="org.apache.hadoop.metrics.jvm">
- <!-- start class org.apache.hadoop.metrics.jvm.EventCounter -->
- <class name="EventCounter" extends="org.apache.hadoop.log.metrics.EventCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link org.apache.hadoop.log.metrics.EventCounter} instead">
- <constructor name="EventCounter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A log4J Appender that simply counts logging events in three levels:
- fatal, error and warn.
- @deprecated use {@link org.apache.hadoop.log.metrics.EventCounter} instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.jvm.EventCounter -->
- <!-- start class org.apache.hadoop.metrics.jvm.JvmMetrics -->
- <class name="JvmMetrics" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <implements name="org.apache.hadoop.metrics.Updater"/>
- <method name="init" return="org.apache.hadoop.metrics.jvm.JvmMetrics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="processName" type="java.lang.String"/>
- <param name="sessionId" type="java.lang.String"/>
- </method>
- <method name="init" return="org.apache.hadoop.metrics.jvm.JvmMetrics"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="processName" type="java.lang.String"/>
- <param name="sessionId" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- </method>
- <method name="doUpdates"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.metrics.MetricsContext"/>
- <doc>
- <![CDATA[This will be called periodically (with the period being configuration
- dependent).]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Singleton class which reports Java Virtual Machine metrics to the metrics API.
- Any application can create an instance of this class in order to emit
- Java VM metrics.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.jvm.JvmMetrics -->
- </package>
- <package name="org.apache.hadoop.metrics.spi">
- <!-- start class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
- <class name="AbstractMetricsContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <implements name="org.apache.hadoop.metrics.MetricsContext"/>
- <constructor name="AbstractMetricsContext"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of AbstractMetricsContext]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- <doc>
- <![CDATA[Initializes the context.]]>
- </doc>
- </method>
- <method name="getAttribute" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[Convenience method for subclasses to access factory attributes.]]>
- </doc>
- </method>
- <method name="getAttributeTable" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="tableName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns an attribute-value map derived from the factory attributes
- by finding all factory attributes that begin with
- <i>contextName</i>.<i>tableName</i>. The returned map consists of
- those attributes with the contextName and tableName stripped off.]]>
- </doc>
- </method>
- <method name="getContextName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the context name.]]>
- </doc>
- </method>
- <method name="getContextFactory" return="org.apache.hadoop.metrics.ContextFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the factory by which this context was created.]]>
- </doc>
- </method>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts or restarts monitoring, the emitting of metrics records.]]>
- </doc>
- </method>
- <method name="stopMonitoring"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring. This does not free buffered data.
- @see #close()]]>
- </doc>
- </method>
- <method name="isMonitoring" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if monitoring is currently in progress.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stops monitoring and frees buffered data, returning this
- object to its initial state.]]>
- </doc>
- </method>
- <method name="createRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="true"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Creates a new AbstractMetricsRecord instance with the given <code>recordName</code>.
- Throws an exception if the metrics implementation is configured with a fixed
- set of record names and <code>recordName</code> is not in that set.
-
- @param recordName the name of the record
- @throws MetricsException if recordName conflicts with configuration data]]>
- </doc>
- </method>
- <method name="newRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- <doc>
- <![CDATA[Subclasses should override this if they subclass MetricsRecordImpl.
- @param recordName the name of the record
- @return newly created instance of MetricsRecordImpl or subclass]]>
- </doc>
- </method>
- <method name="registerUpdater"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Registers a callback to be called at time intervals determined by
- the configuration.
- @param updater object to be run periodically; it should update
- some metrics records]]>
- </doc>
- </method>
- <method name="unregisterUpdater"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- <doc>
- <![CDATA[Removes a callback, if it exists.
- @param updater object to be removed from the callback list]]>
- </doc>
- </method>
- <method name="getAllRecords" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieves all the records managed by this MetricsContext.
- Useful for monitoring systems that are polling-based.
- @return A non-null collection of all monitoring records.]]>
- </doc>
- </method>
- <method name="emitRecord"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sends a record to the metrics system.]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called each period after all records have been emitted, this method does nothing.
- Subclasses may override it in order to perform some kind of flush.]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Called by MetricsRecordImpl.update(). Creates or updates a row in
- the internal table of metric data.]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Called by MetricsRecordImpl.remove(). Removes all matching rows in
- the internal table of metric data. A row matches if it has the same
- tag names and values as record, but it may also have additional
- tags.]]>
- </doc>
- </method>
- <method name="getPeriod" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the timer period.]]>
- </doc>
- </method>
- <method name="setPeriod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="period" type="int"/>
- <doc>
- <![CDATA[Sets the timer period]]>
- </doc>
- </method>
- <method name="parseAndSetPeriod"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <doc>
- <![CDATA[If a period is set in the attribute passed in, override
- the default with it.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The main class of the Service Provider Interface. This class should be
- extended in order to integrate the Metrics API with a specific metrics
- client library. <p/>
- This class implements the internal table of metric data, and the timer
- on which data is to be sent to the metrics system. Subclasses must
- override the abstract <code>emitRecord</code> method in order to transmit
- the data. <p/>
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
- <!-- start class org.apache.hadoop.metrics.spi.AbstractMetricsContext.MetricMap -->
- <class name="AbstractMetricsContext.MetricMap" extends="java.util.TreeMap"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.AbstractMetricsContext.MetricMap -->
- <!-- start class org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap -->
- <class name="AbstractMetricsContext.TagMap" extends="java.util.TreeMap"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="containsAll" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap"/>
- <doc>
- <![CDATA[Returns true if this tagmap contains every tag in other.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap -->
- <!-- start class org.apache.hadoop.metrics.spi.CompositeContext -->
- <class name="CompositeContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="CompositeContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="newRecord" return="org.apache.hadoop.metrics.MetricsRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recordName" type="java.lang.String"/>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="stopMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isMonitoring" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if all subcontexts are monitoring.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="registerUpdater"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- </method>
- <method name="unregisterUpdater"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updater" type="org.apache.hadoop.metrics.Updater"/>
- </method>
- <doc>
- <![CDATA[@deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.CompositeContext -->
- <!-- start class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
- <class name="MetricsRecordImpl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <implements name="org.apache.hadoop.metrics.MetricsRecord"/>
- <constructor name="MetricsRecordImpl" type="java.lang.String, org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of FileRecord]]>
- </doc>
- </constructor>
- <method name="getRecordName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the record name.
- @return the record name]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="int"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="long"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="short"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <param name="tagValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named tag to the specified value.
- @param tagName name of the tag
- @param tagValue new value of the tag
- @throws MetricsException if the tagName conflicts with the configuration]]>
- </doc>
- </method>
- <method name="removeTag"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tagName" type="java.lang.String"/>
- <doc>
- <![CDATA[Removes any tag of the specified name.]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="setMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Sets the named metric to the specified value.
- @param metricName name of the metric
- @param metricValue new value of the metric
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="int"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="long"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="short"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="byte"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="incrMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <param name="metricValue" type="float"/>
- <doc>
- <![CDATA[Increments the named metric by the specified value.
- @param metricName name of the metric
- @param metricValue incremental value
- @throws MetricsException if the metricName or the type of the metricValue
- conflicts with the configuration]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Updates the table of buffered data which is to be sent periodically.
- If the tag values match an existing row, that row is updated;
- otherwise, a new row is added.]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Removes the row, if it exists, in the buffered data table having tags
- that equal the tags that have been set on this record.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An implementation of MetricsRecord. Keeps a back-pointer to the context
- from which it was created, and delegates back to it on <code>update</code>
- and <code>remove()</code>.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
- <!-- start class org.apache.hadoop.metrics.spi.MetricValue -->
- <class name="MetricValue" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="MetricValue" type="java.lang.Number, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of MetricValue]]>
- </doc>
- </constructor>
- <method name="isIncrement" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isAbsolute" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumber" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="ABSOLUTE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INCREMENT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Number that is either an absolute or an incremental amount.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.MetricValue -->
- <!-- start class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
- <class name="NoEmitMetricsContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="NoEmitMetricsContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <doc>
- <![CDATA[Do-nothing version of emitRecord]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A MetricsContext that does not emit data, but, unlike NullContextWithUpdate,
- does save it for retrieval with getAllRecords().
-
- This is useful if you want to support {@link MetricsServlet}, but
- not emit metrics in any other way.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
- <!-- start class org.apache.hadoop.metrics.spi.NullContext -->
- <class name="NullContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="NullContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContext]]>
- </doc>
- </constructor>
- <method name="startMonitoring"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Do-nothing version of startMonitoring]]>
- </doc>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <doc>
- <![CDATA[Do-nothing version of emitRecord]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Do-nothing version of update]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Do-nothing version of remove]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Null metrics context: a metrics context which does nothing. Used as the
- default context, so that no performance data is emitted if no configuration
- data is found.
-
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NullContext -->
- <!-- start class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
- <class name="NullContextWithUpdateThread" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="NullContextWithUpdateThread"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
- </method>
- <method name="emitRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="contextName" type="java.lang.String"/>
- <param name="recordName" type="java.lang.String"/>
- <param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
- <doc>
- <![CDATA[Do-nothing version of emitRecord]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Do-nothing version of update]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
- <doc>
- <![CDATA[Do-nothing version of remove]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A null context which has a thread calling
- periodically when monitoring is started. This keeps the data sampled
- correctly.
- In all other respects, this is like the NULL context: No data is emitted.
- This is suitable for Monitoring systems like JMX which reads the metrics
- when someone reads the data from JMX.
-
- The default impl of start and stop monitoring:
- is the AbstractMetricsContext is good enough.
-
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
- <!-- start class org.apache.hadoop.metrics.spi.OutputRecord -->
- <class name="OutputRecord" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <method name="getTagNames" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the set of tag names]]>
- </doc>
- </method>
- <method name="getTag" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a tag object which is can be a String, Integer, Short or Byte.
- @return the tag value, or null if there is no such tag]]>
- </doc>
- </method>
- <method name="getMetricNames" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the set of metric names.]]>
- </doc>
- </method>
- <method name="getMetric" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the metric object which can be a Float, Integer, Short or Byte.]]>
- </doc>
- </method>
- <method name="getTagsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a copy of this record's tags.]]>
- </doc>
- </method>
- <method name="getMetricsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.MetricMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a copy of this record's metrics.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents a record of metric data to be sent to a metrics system.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.OutputRecord -->
- <!-- start class org.apache.hadoop.metrics.spi.Util -->
- <class name="Util" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="parse" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="specs" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Parses a space and/or comma separated sequence of server specifications
- of the form <i>hostname</i> or <i>hostname:port</i>. If
- the specs string is null, defaults to localhost:defaultPort.
-
- @return a list of InetSocketAddress objects.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Static utility methods]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.spi.Util -->
- </package>
- <package name="org.apache.hadoop.metrics.util">
- <!-- start class org.apache.hadoop.metrics.util.MBeanUtil -->
- <class name="MBeanUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.util.MBeans}.">
- <constructor name="MBeanUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="registerMBean" return="javax.management.ObjectName"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serviceName" type="java.lang.String"/>
- <param name="nameName" type="java.lang.String"/>
- <param name="theMbean" type="java.lang.Object"/>
- <doc>
- <![CDATA[Register the MBean using our standard MBeanName format
- "hadoop:service=<serviceName>,name=<nameName>"
- Where the <serviceName> and <nameName> are the supplied parameters
-
- @param serviceName
- @param nameName
- @param theMbean - the MBean to register
- @return the named used to register the MBean]]>
- </doc>
- </method>
- <method name="unregisterMBean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mbeanName" type="javax.management.ObjectName"/>
- </method>
- <doc>
- <![CDATA[This util class provides a method to register an MBean using
- our standard naming convention as described in the doc
- for {@link #registerMBean(String, String, Object)}
- @deprecated in favor of {@link org.apache.hadoop.metrics2.util.MBeans}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MBeanUtil -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsBase -->
- <class name="MetricsBase" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="MetricsBase" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="MetricsBase" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="pushMetric"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDescription" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="NO_DESCRIPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This is base class for all metrics
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsBase -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsDynamicMBeanBase -->
- <class name="MetricsDynamicMBeanBase" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <implements name="javax.management.DynamicMBean"/>
- <constructor name="MetricsDynamicMBeanBase" type="org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getAttribute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <exception name="AttributeNotFoundException" type="javax.management.AttributeNotFoundException"/>
- <exception name="MBeanException" type="javax.management.MBeanException"/>
- <exception name="ReflectionException" type="javax.management.ReflectionException"/>
- </method>
- <method name="getAttributes" return="javax.management.AttributeList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeNames" type="java.lang.String[]"/>
- </method>
- <method name="getMBeanInfo" return="javax.management.MBeanInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="invoke" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="actionName" type="java.lang.String"/>
- <param name="parms" type="java.lang.Object[]"/>
- <param name="signature" type="java.lang.String[]"/>
- <exception name="MBeanException" type="javax.management.MBeanException"/>
- <exception name="ReflectionException" type="javax.management.ReflectionException"/>
- </method>
- <method name="setAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attribute" type="javax.management.Attribute"/>
- <exception name="AttributeNotFoundException" type="javax.management.AttributeNotFoundException"/>
- <exception name="InvalidAttributeValueException" type="javax.management.InvalidAttributeValueException"/>
- <exception name="MBeanException" type="javax.management.MBeanException"/>
- <exception name="ReflectionException" type="javax.management.ReflectionException"/>
- </method>
- <method name="setAttributes" return="javax.management.AttributeList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="javax.management.AttributeList"/>
- </method>
- <doc>
- <![CDATA[This abstract base class facilitates creating dynamic mbeans automatically from
- metrics.
- The metrics constructors registers metrics in a registry.
- Different categories of metrics should be in differnt classes with their own
- registry (as in NameNodeMetrics and DataNodeMetrics).
- Then the MBean can be created passing the registry to the constructor.
- The MBean should be then registered using a mbean name (example):
- MetricsHolder myMetrics = new MetricsHolder(); // has metrics and registry
- MetricsTestMBean theMBean = new MetricsTestMBean(myMetrics.mregistry);
- ObjectName mbeanName = MBeanUtil.registerMBean("ServiceFoo",
- "TestStatistics", theMBean);
-
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsDynamicMBeanBase -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsIntValue -->
- <class name="MetricsIntValue" extends="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt}.">
- <constructor name="MetricsIntValue" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered]]>
- </doc>
- </constructor>
- <constructor name="MetricsIntValue" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- A description of {@link #NO_DESCRIPTION} is used]]>
- </doc>
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="int"/>
- <doc>
- <![CDATA[Set the value
- @param newValue]]>
- </doc>
- </method>
- <method name="get" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get value
- @return the value last set]]>
- </doc>
- </method>
- <method name="pushMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- <doc>
- <![CDATA[Push the metric to the mr.
- The metric is pushed only if it was updated since last push
-
- Note this does NOT push to JMX
- (JMX gets the info via {@link #get()}
- @param mr]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MetricsIntValue class is for a metric that is not time varied
- but changes only when it is set.
- Each time its value is set, it is published only *once* at the next update
- call.
- @deprecated in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsIntValue -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsLongValue -->
- <class name="MetricsLongValue" extends="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of lEsS_tHaNcode>org.apache.hadoop.metrics2lEsS_tHaN/code> usage.">
- <constructor name="MetricsLongValue" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered]]>
- </doc>
- </constructor>
- <constructor name="MetricsLongValue" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- A description of {@link #NO_DESCRIPTION} is used]]>
- </doc>
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="long"/>
- <doc>
- <![CDATA[Set the value
- @param newValue]]>
- </doc>
- </method>
- <method name="get" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get value
- @return the value last set]]>
- </doc>
- </method>
- <method name="pushMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- <doc>
- <![CDATA[Push the metric to the mr.
- The metric is pushed only if it was updated since last push
-
- Note this does NOT push to JMX
- (JMX gets the info via {@link #get()}
- @param mr]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MetricsLongValue class is for a metric that is not time varied
- but changes only when it is set.
- Each time its value is set, it is published only *once* at the next update
- call.
- @deprecated in favor of <code>org.apache.hadoop.metrics2</code> usage.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsLongValue -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsRegistry -->
- <class name="MetricsRegistry" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.lib.MetricsRegistry}.">
- <constructor name="MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of metrics in the registry]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricsName" type="java.lang.String"/>
- <param name="theMetricsObj" type="org.apache.hadoop.metrics.util.MetricsBase"/>
- <doc>
- <![CDATA[Add a new metrics to the registry
- @param metricsName - the name
- @param theMetricsObj - the metrics
- @throws IllegalArgumentException if a name is already registered]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricsName" type="java.lang.String"/>
- <doc>
- <![CDATA[@param metricsName
- @return the metrics if there is one registered by the supplied name.
- Returns null if none is registered]]>
- </doc>
- </method>
- <method name="getKeyList" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the list of metrics names]]>
- </doc>
- </method>
- <method name="getMetricsList" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the list of metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is the registry for metrics.
- Related set of metrics should be declared in a holding class and registered
- in a registry for those metrics which is also stored in the the holding class.
- @deprecated in favor of {@link org.apache.hadoop.metrics2.lib.MetricsRegistry}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsRegistry -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsTimeVaryingInt -->
- <class name="MetricsTimeVaryingInt" extends="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableCounterInt}.">
- <constructor name="MetricsTimeVaryingInt" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- @param description - the description]]>
- </doc>
- </constructor>
- <constructor name="MetricsTimeVaryingInt" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- A description of {@link #NO_DESCRIPTION} is used]]>
- </doc>
- </constructor>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="incr" type="int"/>
- <doc>
- <![CDATA[Inc metrics for incr vlaue
- @param incr - number of operations]]>
- </doc>
- </method>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Inc metrics by one]]>
- </doc>
- </method>
- <method name="pushMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- <doc>
- <![CDATA[Push the delta metrics to the mr.
- The delta is since the last push/interval.
-
- Note this does NOT push to JMX
- (JMX gets the info via {@link #previousIntervalValue}
- @param mr]]>
- </doc>
- </method>
- <method name="getPreviousIntervalValue" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Value at the Previous interval
- @return prev interval value]]>
- </doc>
- </method>
- <method name="getCurrentIntervalValue" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Value at the current interval
- @return prev interval value]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MetricsTimeVaryingInt class is for a metric that naturally
- varies over time (e.g. number of files created). The metrics is accumulated
- over an interval (set in the metrics config file); the metrics is
- published at the end of each interval and then
- reset to zero. Hence the counter has the value in the current interval.
-
- Note if one wants a time associated with the metric then use
- @see org.apache.hadoop.metrics.util.MetricsTimeVaryingRate
- @deprecated in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableCounterInt}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsTimeVaryingInt -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsTimeVaryingLong -->
- <class name="MetricsTimeVaryingLong" extends="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableCounterLong}.">
- <constructor name="MetricsTimeVaryingLong" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered]]>
- </doc>
- </constructor>
- <constructor name="MetricsTimeVaryingLong" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- A description of {@link #NO_DESCRIPTION} is used]]>
- </doc>
- </constructor>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="incr" type="long"/>
- <doc>
- <![CDATA[Inc metrics for incr vlaue
- @param incr - number of operations]]>
- </doc>
- </method>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Inc metrics by one]]>
- </doc>
- </method>
- <method name="pushMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- <doc>
- <![CDATA[Push the delta metrics to the mr.
- The delta is since the last push/interval.
-
- Note this does NOT push to JMX
- (JMX gets the info via {@link #previousIntervalValue}
- @param mr]]>
- </doc>
- </method>
- <method name="getPreviousIntervalValue" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Value at the Previous interval
- @return prev interval value]]>
- </doc>
- </method>
- <method name="getCurrentIntervalValue" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Value at the current interval
- @return prev interval value]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MetricsTimeVaryingLong class is for a metric that naturally
- varies over time (e.g. number of files created). The metrics is accumulated
- over an interval (set in the metrics config file); the metrics is
- published at the end of each interval and then
- reset to zero. Hence the counter has the value in the current interval.
-
- Note if one wants a time associated with the metric then use
- @see org.apache.hadoop.metrics.util.MetricsTimeVaryingRate
- @deprecated in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableCounterLong}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsTimeVaryingLong -->
- <!-- start class org.apache.hadoop.metrics.util.MetricsTimeVaryingRate -->
- <class name="MetricsTimeVaryingRate" extends="org.apache.hadoop.metrics.util.MetricsBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableGauge}.">
- <constructor name="MetricsTimeVaryingRate" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered]]>
- </doc>
- </constructor>
- <constructor name="MetricsTimeVaryingRate" type="java.lang.String, org.apache.hadoop.metrics.util.MetricsRegistry"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor - create a new metric
- @param nam the name of the metrics to be used to publish the metric
- @param registry - where the metrics object will be registered
- A description of {@link #NO_DESCRIPTION} is used]]>
- </doc>
- </constructor>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numOps" type="int"/>
- <param name="time" type="long"/>
- <doc>
- <![CDATA[Increment the metrics for numOps operations
- @param numOps - number of operations
- @param time - time for numOps operations]]>
- </doc>
- </method>
- <method name="inc"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="time" type="long"/>
- <doc>
- <![CDATA[Increment the metrics for one operation
- @param time for one operation]]>
- </doc>
- </method>
- <method name="pushMetric"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics.MetricsRecord"/>
- <doc>
- <![CDATA[Push the delta metrics to the mr.
- The delta is since the last push/interval.
-
- Note this does NOT push to JMX
- (JMX gets the info via {@link #getPreviousIntervalAverageTime()} and
- {@link #getPreviousIntervalNumOps()}
- @param mr]]>
- </doc>
- </method>
- <method name="getPreviousIntervalNumOps" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of operations in the previous interval
- @return - ops in prev interval]]>
- </doc>
- </method>
- <method name="getPreviousIntervalAverageTime" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The average rate of an operation in the previous interval
- @return - the average rate.]]>
- </doc>
- </method>
- <method name="getMinTime" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The min time for a single operation since the last reset
- {@link #resetMinMax()}
- @return min time for an operation]]>
- </doc>
- </method>
- <method name="getMaxTime" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The max time for a single operation since the last reset
- {@link #resetMinMax()}
- @return max time for an operation]]>
- </doc>
- </method>
- <method name="resetMinMax"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the min max values]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MetricsTimeVaryingRate class is for a rate based metric that
- naturally varies over time (e.g. time taken to create a file).
- The rate is averaged at each interval heart beat (the interval
- is set in the metrics config file).
- This class also keeps track of the min and max rates along with
- a method to reset the min-max.
- @deprecated in favor of {@link org.apache.hadoop.metrics2.lib.MetricMutableGauge}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics.util.MetricsTimeVaryingRate -->
- </package>
- <package name="org.apache.hadoop.metrics2">
- <!-- start class org.apache.hadoop.metrics2.Metric -->
- <class name="Metric" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Metric" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metric with name only
- @param name of the metric]]>
- </doc>
- </constructor>
- <constructor name="Metric" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metric with a name and a description
- @param name of the metric
- @param desc description of the metric]]>
- </doc>
- </constructor>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the metric
- @return the name]]>
- </doc>
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the description of the metric
- @return the description]]>
- </doc>
- </method>
- <method name="value" return="java.lang.Number"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value of the metric
- @return the value of the metric]]>
- </doc>
- </method>
- <method name="visit"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="visitor" type="org.apache.hadoop.metrics2.MetricsVisitor"/>
- <doc>
- <![CDATA[Accept a visitor interface
- @param visitor of the metric]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="NO_DESCRIPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The immutable metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.Metric -->
- <!-- start class org.apache.hadoop.metrics2.MetricCounter -->
- <class name="MetricCounter" extends="org.apache.hadoop.metrics2.Metric"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricCounter" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a counter metric
- @param name of the metric
- @param description of the metric]]>
- </doc>
- </constructor>
- <method name="value" return="java.lang.Number"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A generic immutable counter metric type
- @param <T> value type of the metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricCounter -->
- <!-- start class org.apache.hadoop.metrics2.MetricGauge -->
- <class name="MetricGauge" extends="org.apache.hadoop.metrics2.Metric"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricGauge" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a gauge metric
- @param name of the metric
- @param description of the metric]]>
- </doc>
- </constructor>
- <method name="value" return="java.lang.Number"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A generic immutable gauge metric
- @param <T> value type of the metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricGauge -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsBuilder -->
- <interface name="MetricsBuilder" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="addRecord" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a metrics record
- @param name of the record
- @return a metrics record builder for the record]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics builder interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsBuilder -->
- <!-- start class org.apache.hadoop.metrics2.MetricsException -->
- <class name="MetricsException" extends="java.lang.RuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a message
- @param message for the exception]]>
- </doc>
- </constructor>
- <constructor name="MetricsException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a message and a cause
- @param message for the exception
- @param cause of the exception]]>
- </doc>
- </constructor>
- <constructor name="MetricsException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the exception with a cause
- @param cause of the exception]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A general metrics exception wrapper]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsException -->
- <!-- start class org.apache.hadoop.metrics2.MetricsFilter -->
- <class name="MetricsFilter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsPlugin"/>
- <constructor name="MetricsFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Whether to accept the name
- @param name to filter on
- @return true to accept; false otherwise.]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- <doc>
- <![CDATA[Whether to accept the tag
- @param tag to filter on
- @return true to accept; false otherwise]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tags" type="java.lang.Iterable"/>
- <doc>
- <![CDATA[Whether to accept the tags
- @param tags to filter on
- @return true to accept; false otherwise]]>
- </doc>
- </method>
- <method name="accepts" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <doc>
- <![CDATA[Whether to accept the record
- @param record to filter on
- @return true to accept; false otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics filter interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsFilter -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsPlugin -->
- <interface name="MetricsPlugin" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- <doc>
- <![CDATA[Initialize the plugin
- @param conf the configuration object for the plugin]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A fairly generic plugin interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsPlugin -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsRecord -->
- <interface name="MetricsRecord" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="timestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the timestamp of the metrics
- @return the timestamp]]>
- </doc>
- </method>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the record name of the metrics
- @return the record name]]>
- </doc>
- </method>
- <method name="context" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the context name of the metrics
- @return the context name]]>
- </doc>
- </method>
- <method name="tags" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the tags of the record
- @return the tags]]>
- </doc>
- </method>
- <method name="metrics" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the metrics of the record
- @return the metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An immutable snapshot of metrics with a timestamp]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsRecord -->
- <!-- start class org.apache.hadoop.metrics2.MetricsRecordBuilder -->
- <class name="MetricsRecordBuilder" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsRecordBuilder"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="tag" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a metrics tag
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @return self]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="org.apache.hadoop.metrics2.MetricsTag"/>
- <doc>
- <![CDATA[Add an immutable metrics tag object
- @param tag a pre-made tag object (potentially save an object construction)
- @return self]]>
- </doc>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the context tag
- @param value of the context
- @return self]]>
- </doc>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Add an int counter metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addCounter" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add an long counter metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Add a int gauge metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add a long gauge metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Add a float gauge metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="addGauge" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="double"/>
- <doc>
- <![CDATA[Add a double gauge metric
- @param name of the metric
- @param description of the metric
- @param value of the metric
- @return self]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.MetricsRecordBuilder"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.Metric"/>
- <doc>
- <![CDATA[Add a pre-made immutable metric object
- @param metric the pre-made metric to save an object construction
- @return self]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics record builder interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsRecordBuilder -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSink -->
- <interface name="MetricsSink" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsPlugin"/>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <doc>
- <![CDATA[Put a metrics record in the sink
- @param record the record to put]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flush any buffered metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics sink interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSink -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSource -->
- <interface name="MetricsSource" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsBuilder"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Get metrics from the source
- @param builder to contain the resulting metrics snapshot
- @param all if true, return all metrics even if unchanged.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics source interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSource -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSystem -->
- <interface name="MetricsSystem" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSystemMXBean"/>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="source" type="org.apache.hadoop.metrics2.MetricsSource"/>
- <doc>
- <![CDATA[Register a metrics source
- @param <T> the type of the source
- @param source to register
- @param name of the source. Must be unique.
- @param desc the description of the source.
- @return the source
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="sink" type="org.apache.hadoop.metrics2.MetricsSink"/>
- <doc>
- <![CDATA[Register a metrics sink
- @param <T> the type of the sink
- @param sink to register
- @param name of the sink. Must be unique.
- @param desc the description of the sink
- @return the sink
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callback" type="org.apache.hadoop.metrics2.MetricsSystem.Callback"/>
- <doc>
- <![CDATA[Register a callback interface for JMX events
- @param callback the callback object implementing the MBean interface.]]>
- </doc>
- </method>
- <method name="publishMetricsNow"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Requests an immediate publish of all metrics from sources to sinks.
-
- This is a "soft" request: the expectation is that a best effort will be
- done to synchronously snapshot the metrics from all the sources and put
- them in all the sinks (including flushing the sinks) before returning to
- the caller. If this can't be accomplished in reasonable time it's OK to
- return to the caller before everything is done.]]>
- </doc>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Shutdown the metrics system completely (usually during server shutdown.)
- The MetricsSystemMXBean will be unregistered.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics system interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSystem -->
- <!-- start class org.apache.hadoop.metrics2.MetricsSystem.AbstractCallback -->
- <class name="MetricsSystem.AbstractCallback" extends="java.lang.Object"
- abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSystem.Callback"/>
- <constructor name="MetricsSystem.AbstractCallback"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="preStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="postStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="preStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="postStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Convenient abstract class for implementing callback interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsSystem.AbstractCallback -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSystem.Callback -->
- <interface name="MetricsSystem.Callback" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="preStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called before start()]]>
- </doc>
- </method>
- <method name="postStart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called after start()]]>
- </doc>
- </method>
- <method name="preStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called before stop()]]>
- </doc>
- </method>
- <method name="postStop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called after stop()]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The metrics system callback interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSystem.Callback -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsSystemMXBean -->
- <interface name="MetricsSystemMXBean" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start the metrics system
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop the metrics system
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="refreshMBeans"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Force a refresh of MBeans
- @exception MetricsException]]>
- </doc>
- </method>
- <method name="currentConfig" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the current config
- Note, avoid getConfig, as it'll turn it into an attribute,
- which doesn't support multiple lines in the values.
- @exception MetricsException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The JMX interface to the metrics system]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsSystemMXBean -->
- <!-- start class org.apache.hadoop.metrics2.MetricsTag -->
- <class name="MetricsTag" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsTag" type="java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the tag with name, description and value
- @param name of the tag
- @param description of the tag
- @param value of the tag]]>
- </doc>
- </constructor>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the tag
- @return the name]]>
- </doc>
- </method>
- <method name="description" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the description of the tag
- @return the description]]>
- </doc>
- </method>
- <method name="value" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value of the tag
- @return the value]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Immutable tag for metrics (for grouping on host/queue/username etc.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.MetricsTag -->
- <!-- start interface org.apache.hadoop.metrics2.MetricsVisitor -->
- <interface name="MetricsVisitor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricGauge"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Callback for int value gauges
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricGauge"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Callback for long value gauges
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricGauge"/>
- <param name="value" type="float"/>
- <doc>
- <![CDATA[Callback for float value gauges
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <method name="gauge"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricGauge"/>
- <param name="value" type="double"/>
- <doc>
- <![CDATA[Callback for double value gauges
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <method name="counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricCounter"/>
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Callback for integer value counters
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <method name="counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.metrics2.MetricCounter"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Callback for long value counters
- @param metric the metric object
- @param value of the metric]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A visitor interface for metrics]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.metrics2.MetricsVisitor -->
- </package>
- <package name="org.apache.hadoop.metrics2.filter">
- <!-- start class org.apache.hadoop.metrics2.filter.GlobFilter -->
- <class name="GlobFilter" extends="org.apache.hadoop.metrics2.filter.AbstractPatternFilter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GlobFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compile" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[A glob pattern filter for metrics]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.filter.GlobFilter -->
- <!-- start class org.apache.hadoop.metrics2.filter.RegexFilter -->
- <class name="RegexFilter" extends="org.apache.hadoop.metrics2.filter.AbstractPatternFilter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegexFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compile" return="java.util.regex.Pattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[A regex pattern filter for metrics]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.filter.RegexFilter -->
- </package>
- <package name="org.apache.hadoop.metrics2.impl">
- <!-- start class org.apache.hadoop.metrics2.impl.MetricsConfigException -->
- <class name="MetricsConfigException" extends="org.apache.hadoop.metrics2.MetricsException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The metrics configuration runtime exception]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.impl.MetricsConfigException -->
- <!-- start class org.apache.hadoop.metrics2.impl.MetricsRecordImpl -->
- <class name="MetricsRecordImpl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsRecord"/>
- <constructor name="MetricsRecordImpl" type="java.lang.String, long, java.lang.Iterable, java.lang.Iterable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a metrics record
- @param name of the record
- @param timestamp of the record
- @param tags of the record
- @param metrics of the record]]>
- </doc>
- </constructor>
- <method name="timestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="context" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="tags" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="metrics" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="CONTEXT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CONTEXT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.metrics2.impl.MetricsRecordImpl -->
- <!-- start class org.apache.hadoop.metrics2.impl.MetricsSystemImpl -->
- <class name="MetricsSystemImpl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSystem"/>
- <constructor name="MetricsSystemImpl" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metrics system
- @param prefix for the system]]>
- </doc>
- </constructor>
- <constructor name="MetricsSystemImpl"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the system but not initializing (read config etc.) it.]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Initialized the metrics system with a prefix.
- @param prefix the system will look for configs with the prefix]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSource"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="source" type="org.apache.hadoop.metrics2.MetricsSource"/>
- </method>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSink"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="sink" type="org.apache.hadoop.metrics2.MetricsSink"/>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callback" type="org.apache.hadoop.metrics2.MetricsSystem.Callback"/>
- </method>
- <method name="refreshMBeans"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="currentConfig" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="publishMetricsNow"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Requests an immediate publish of all metrics from sources to sinks.]]>
- </doc>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A base class for metrics system singletons]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.impl.MetricsSystemImpl -->
- </package>
- <package name="org.apache.hadoop.metrics2.lib">
- <!-- start class org.apache.hadoop.metrics2.lib.AbstractMetricsSource -->
- <class name="AbstractMetricsSource" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSource"/>
- <constructor name="AbstractMetricsSource" type="java.lang.String, org.apache.hadoop.metrics2.lib.MetricMutableFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the source with name and a mutable metrics factory
- @param name of the default record
- @param mf the factory to create mutable metrics]]>
- </doc>
- </constructor>
- <constructor name="AbstractMetricsSource" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the source with a name with a default factory
- @param name of the default record]]>
- </doc>
- </constructor>
- <method name="registry" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the registry for mutable metrics]]>
- </doc>
- </method>
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <field name="registry" type="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A convenient base class for writing metrics sources]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.AbstractMetricsSource -->
- <!-- start class org.apache.hadoop.metrics2.lib.DefaultMetricsSystem -->
- <class name="DefaultMetricsSystem" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSystem"/>
- <method name="values" return="org.apache.hadoop.metrics2.lib.DefaultMetricsSystem[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.metrics2.lib.DefaultMetricsSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="initialize" return="org.apache.hadoop.metrics2.MetricsSystem"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prefix" type="java.lang.String"/>
- <doc>
- <![CDATA[Common static convenience method to initialize the metrics system
- @param prefix for configuration
- @return the metrics system instance]]>
- </doc>
- </method>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="source" type="org.apache.hadoop.metrics2.MetricsSource"/>
- </method>
- <method name="registerSource" return="org.apache.hadoop.metrics2.MetricsSource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="source" type="org.apache.hadoop.metrics2.MetricsSource"/>
- <doc>
- <![CDATA[Common static method to register a source
- @param <T> type of the source
- @param name of the source
- @param desc description
- @param source the source object to register
- @return the source object]]>
- </doc>
- </method>
- <method name="register" return="org.apache.hadoop.metrics2.MetricsSink"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="desc" type="java.lang.String"/>
- <param name="sink" type="org.apache.hadoop.metrics2.MetricsSink"/>
- </method>
- <method name="register"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callback" type="org.apache.hadoop.metrics2.MetricsSystem.Callback"/>
- </method>
- <method name="publishMetricsNow"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="refreshMBeans"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="currentConfig" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="INSTANCE" type="org.apache.hadoop.metrics2.lib.DefaultMetricsSystem"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The singleton instance]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The default metrics system singleton]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.DefaultMetricsSystem -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutable -->
- <class name="MetricMutable" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutable" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a mutable metric
- @param name of the metric
- @param description of the metric]]>
- </doc>
- </constructor>
- <method name="snapshot"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Get a snapshot/snapshot of the metric
- @param builder the metrics record builder
- @param all if true, snapshot unchanged metrics as well]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <doc>
- <![CDATA[Get a sampe/snapshot of metric if changed
- @param builder the metrics record builder]]>
- </doc>
- </method>
- <method name="setChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set the changed flag in mutable operations]]>
- </doc>
- </method>
- <method name="clearChanged"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clear the changed flag in the snapshot operations]]>
- </doc>
- </method>
- <method name="changed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if metric is changed since last snapshot/snapshot]]>
- </doc>
- </method>
- <field name="name" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[name of the metric]]>
- </doc>
- </field>
- <field name="description" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[description of the metric]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The mutable metric interface]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutable -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableCounter -->
- <class name="MetricMutableCounter" extends="org.apache.hadoop.metrics2.lib.MetricMutable"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableCounter" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metric with name and description
- @param name
- @param description]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Increment the metric value by 1.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The mutable counter (monotonically increasing) metric interface
- @param <T> the type of the metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableCounter -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableCounterInt -->
- <class name="MetricMutableCounterInt" extends="org.apache.hadoop.metrics2.lib.MetricMutableCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableCounterInt" type="java.lang.String, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a mutable int counter
- @param name of the counter
- @param description of the counter
- @param initValue the initial value of the counter]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[Increment the value by a delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable int counter for implementing metrics sources]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableCounterInt -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableCounterLong -->
- <class name="MetricMutableCounterLong" extends="org.apache.hadoop.metrics2.lib.MetricMutableCounter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableCounterLong" type="java.lang.String, java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a mutable long counter
- @param name of the counter
- @param description of the counter
- @param initValue the initial value of the counter]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[Increment the value by a delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable long counter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableCounterLong -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableFactory -->
- <class name="MetricMutableFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newMetric" return="org.apache.hadoop.metrics2.lib.MetricMutable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a new mutable metric by name
- Usually overridden by app specific factory
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer counter
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newCounterInt" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable integer counter with name only.
- Usually gets overridden.
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer counter
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newCounterLong" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable long integer counter with a name
- Usually gets overridden.
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer gauge
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newGaugeInt" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable integer gauge with name only.
- Usually gets overridden.
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer gauge
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newGaugeLong" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable long integer gauge with name only.
- Usually gets overridden.
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MetricMutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <param name="extended" type="boolean"/>
- <doc>
- <![CDATA[Create a mutable stat metric
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g., ops)
- @param valueName of the metric (e.g., time or latency)
- @param extended if true, produces extended stat (stdev, min/max etc.)
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MetricMutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable stat metric with name only.
- Usually gets overridden.
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Factory class for mutable metrics]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableFactory -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableGauge -->
- <class name="MetricMutableGauge" extends="org.apache.hadoop.metrics2.lib.MetricMutable"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableGauge" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the metric with name and description
- @param name of the metric
- @param description of the metric]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Increment the value of the metric by 1]]>
- </doc>
- </method>
- <method name="decr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Decrement the value of the metric by 1]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The mutable gauge metric interface
- @param <T> the type of the metric]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableGauge -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt -->
- <class name="MetricMutableGaugeInt" extends="org.apache.hadoop.metrics2.lib.MetricMutableGauge"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableGaugeInt" type="java.lang.String, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a mutable int gauge metric
- @param name of the gauge
- @param description of the gauge
- @param initValue the initial value of the gauge]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[Increment by delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="int"/>
- <doc>
- <![CDATA[decrement by delta
- @param delta of the decrement]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="int"/>
- <doc>
- <![CDATA[Set the value of the metric
- @param value to set]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable int gauge]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableGaugeLong -->
- <class name="MetricMutableGaugeLong" extends="org.apache.hadoop.metrics2.lib.MetricMutableGauge"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableGaugeLong" type="java.lang.String, java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a mutable long gauge metric
- @param name of the gauge
- @param description of the gauge
- @param initValue the initial value of the gauge]]>
- </doc>
- </constructor>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[Increment by delta
- @param delta of the increment]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="delta" type="long"/>
- <doc>
- <![CDATA[decrement by delta
- @param delta of the decrement]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of the metric
- @param value to set]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <doc>
- <![CDATA[A mutable long gauge]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableGaugeLong -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricMutableStat -->
- <class name="MetricMutableStat" extends="org.apache.hadoop.metrics2.lib.MetricMutable"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricMutableStat" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a sample statistics metric
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g. "ops")
- @param valueName of the metric (e.g. "time", "latency")
- @param extended create extended stats (stdev, min/max etc.) by default.]]>
- </doc>
- </constructor>
- <constructor name="MetricMutableStat" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a snapshot stat metric with extended stat off by default
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g. "ops")
- @param valueName of the metric (e.g. "time", "latency")]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numSamples" type="long"/>
- <param name="sum" type="long"/>
- <doc>
- <![CDATA[Add a number of samples and their sum to the running stat
- @param numSamples number of samples
- @param sum of the samples]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add a snapshot to the metric
- @param value of the metric]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="resetMinMax"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the all time min max of the metric]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A mutable metric with stats
- Useful for keep throughput/latency stats.
- e.g., new MetricMutableStat("rpcName", "rpcName stats", "ops", "time");]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricMutableStat -->
- <!-- start class org.apache.hadoop.metrics2.lib.MetricsRegistry -->
- <class name="MetricsRegistry" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsRegistry" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the registry with a record name
- @param name of the record of the metrics]]>
- </doc>
- </constructor>
- <constructor name="MetricsRegistry" type="java.lang.String, org.apache.hadoop.metrics2.lib.MetricMutableFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct the registry with a name and a metric factory
- @param name of the record of the metrics
- @param factory for creating new mutable metrics]]>
- </doc>
- </constructor>
- <method name="name" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the name of the metrics registry]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.metrics2.lib.MetricMutable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a metric by name
- @param name of the metric
- @return the metric object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer counter
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newCounter" return="org.apache.hadoop.metrics2.lib.MetricMutableCounterLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer counter
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new counter object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="int"/>
- <doc>
- <![CDATA[Create a mutable integer gauge
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newGauge" return="org.apache.hadoop.metrics2.lib.MetricMutableGaugeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="initValue" type="long"/>
- <doc>
- <![CDATA[Create a mutable long integer gauge
- @param name of the metric
- @param description of the metric
- @param initValue of the metric
- @return a new gauge object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MetricMutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <param name="extended" type="boolean"/>
- <doc>
- <![CDATA[Create a mutable metric with stats
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g., "ops")
- @param valueName of the metric (e.g., "time" or "latency")
- @param extended produce extended stat (stdev, min/max etc.) if true.
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MetricMutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="sampleName" type="java.lang.String"/>
- <param name="valueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable metric with stats
- @param name of the metric
- @param description of the metric
- @param sampleName of the metric (e.g., "ops")
- @param valueName of the metric (e.g., "time" or "latency")
- @return a new metric object]]>
- </doc>
- </method>
- <method name="newStat" return="org.apache.hadoop.metrics2.lib.MetricMutableStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a mutable metric with stats using the name only
- @param name of the metric
- @return a new metric object]]>
- </doc>
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Increment a metric by name.
- @param name of the metric]]>
- </doc>
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics2.lib.MetricMutableFactory"/>
- <doc>
- <![CDATA[Increment a metric by name.
- @param name of the metric
- @param factory to lazily create the metric if not null]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Decrement a metric by name.
- @param name of the metric]]>
- </doc>
- </method>
- <method name="decr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="factory" type="org.apache.hadoop.metrics2.lib.MetricMutableFactory"/>
- <doc>
- <![CDATA[Decrement a metric by name.
- @param name of the metric
- @param factory to lazily create the metric if not null]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Add a value to a metric by name.
- @param name of the metric
- @param value of the snapshot to add]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="value" type="long"/>
- <param name="factory" type="org.apache.hadoop.metrics2.lib.MetricMutableFactory"/>
- <doc>
- <![CDATA[Decrement a metric by name.
- @param name of the metric
- @param value of the snapshot to add
- @param factory to lazily create the metric if not null]]>
- </doc>
- </method>
- <method name="setContext" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the metrics context tag
- @param name of the context
- @return the registry itself as a convenience]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a tag to the metrics
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @return the registry (for keep adding tags)]]>
- </doc>
- </method>
- <method name="tag" return="org.apache.hadoop.metrics2.lib.MetricsRegistry"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="description" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <param name="override" type="boolean"/>
- <doc>
- <![CDATA[Add a tag to the metrics
- @param name of the tag
- @param description of the tag
- @param value of the tag
- @param override existing tag if true
- @return the registry (for keep adding tags)]]>
- </doc>
- </method>
- <method name="tags" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the tags
- @return the tags set]]>
- </doc>
- </method>
- <method name="metrics" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the metrics
- @return the metrics set]]>
- </doc>
- </method>
- <method name="snapshot"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsRecordBuilder"/>
- <param name="all" type="boolean"/>
- <doc>
- <![CDATA[Sample all the mutable metrics and put the snapshot in the builder
- @param builder to contain the metrics snapshot
- @param all get all the metrics even if the values are not changed.]]>
- </doc>
- </method>
- <field name="CONTEXT_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[key for the context tag]]>
- </doc>
- </field>
- <field name="CONTEXT_DESC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[description for the context tag]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An optional metrics registry class for creating and maintaining a
- collection of MetricsMutables, making writing metrics source easier.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.lib.MetricsRegistry -->
- </package>
- <package name="org.apache.hadoop.metrics2.sink">
- <!-- start class org.apache.hadoop.metrics2.sink.FileSink -->
- <class name="FileSink" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <constructor name="FileSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.FileSink -->
- </package>
- <package name="org.apache.hadoop.metrics2.sink.ganglia">
- <!-- start class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink -->
- <class name="AbstractGangliaSink" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSink"/>
- <constructor name="AbstractGangliaSink"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.commons.configuration.SubsetConfiguration"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getGangliaConfForMetric" return="org.apache.hadoop.metrics2.sink.ganglia.GangliaConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="metricName" type="java.lang.String"/>
- <doc>
- <![CDATA[Lookup GangliaConf from cache. If not found, return default values
- @param metricName
- @return looked up GangliaConf]]>
- </doc>
- </method>
- <method name="getHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the hostName]]>
- </doc>
- </method>
- <method name="xdr_string"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Puts a string into the buffer by first writing the size of the string as an
- int, followed by the bytes of the string, padded if necessary to a multiple
- of 4.
- @param s the string to be written to buffer at offset location]]>
- </doc>
- </method>
- <method name="xdr_int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Puts an integer into the buffer as 4 bytes, big-endian.]]>
- </doc>
- </method>
- <method name="emitToGangliaHosts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sends Ganglia Metrics to the configured hosts
- @throws IOException]]>
- </doc>
- </method>
- <method name="isSupportSparseMetrics" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return whether sparse metrics are supported]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_UNITS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TMAX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_DMAX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SLOPE" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SERVERS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BUFFER_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUPPORT_SPARSE_METRICS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUPPORT_SPARSE_METRICS_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EQUAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="gangliaMetricVisitor" type="org.apache.hadoop.metrics2.sink.ganglia.GangliaMetricVisitor"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Used for visiting Metrics]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This the base class for Ganglia sink classes using metrics2. Lot of the code
- has been derived from org.apache.hadoop.metrics.ganglia.GangliaContext.
- As per the documentation, sink implementations doesn't have to worry about
- thread safety. Hence the code wasn't written for thread safety and should
- be modified in case the above assumption changes in the future.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink -->
- <!-- start class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType -->
- <class name="AbstractGangliaSink.GangliaConfType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="slope" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="units" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="dmax" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="tmax" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[define enum for various type of conf]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaConfType -->
- <!-- start class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope -->
- <class name="AbstractGangliaSink.GangliaSlope" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="zero" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="positive" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="negative" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="both" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[ganglia slope values which equal the ordinal]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope -->
- <!-- start class org.apache.hadoop.metrics2.sink.ganglia.GangliaSink30 -->
- <class name="GangliaSink30" extends="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GangliaSink30"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="putMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="record" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="emitMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- <param name="type" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <param name="gConf" type="org.apache.hadoop.metrics2.sink.ganglia.GangliaConf"/>
- <param name="gSlope" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The method sends metrics to Ganglia servers. The method has been taken from
- org.apache.hadoop.metrics.ganglia.GangliaContext30 with minimal changes in
- order to keep it in sync.
- @param groupName The group name of the metric
- @param name The metric name
- @param type The type of the metric
- @param value The value of the metric
- @param gConf The GangliaConf for this metric
- @param gSlope The slope for this metric
- @throws IOException]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="metricsCache" type="org.apache.hadoop.metrics2.util.MetricsCache"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This code supports Ganglia 3.0]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.ganglia.GangliaSink30 -->
- <!-- start class org.apache.hadoop.metrics2.sink.ganglia.GangliaSink31 -->
- <class name="GangliaSink31" extends="org.apache.hadoop.metrics2.sink.ganglia.GangliaSink30"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GangliaSink31"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="emitMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- <param name="type" type="java.lang.String"/>
- <param name="value" type="java.lang.String"/>
- <param name="gConf" type="org.apache.hadoop.metrics2.sink.ganglia.GangliaConf"/>
- <param name="gSlope" type="org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink.GangliaSlope"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The method sends metrics to Ganglia servers. The method has been taken from
- org.apache.hadoop.metrics.ganglia.GangliaContext31 with minimal changes in
- order to keep it in sync.
- @param groupName The group name of the metric
- @param name The metric name
- @param type The type of the metric
- @param value The value of the metric
- @param gConf The GangliaConf for this metric
- @param gSlope The slope for this metric
- @throws IOException]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This code supports Ganglia 3.1]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.sink.ganglia.GangliaSink31 -->
- </package>
- <package name="org.apache.hadoop.metrics2.source">
- <!-- start class org.apache.hadoop.metrics2.source.JvmMetricsSource -->
- <class name="JvmMetricsSource" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSource"/>
- <method name="create" return="org.apache.hadoop.metrics2.source.JvmMetricsSource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="processName" type="java.lang.String"/>
- <param name="sessionId" type="java.lang.String"/>
- <param name="ms" type="org.apache.hadoop.metrics2.MetricsSystem"/>
- </method>
- <method name="create" return="org.apache.hadoop.metrics2.source.JvmMetricsSource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="processName" type="java.lang.String"/>
- <param name="sessionId" type="java.lang.String"/>
- </method>
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.metrics2.source.JvmMetricsSource -->
- </package>
- <package name="org.apache.hadoop.metrics2.util">
- <!-- start class org.apache.hadoop.metrics2.util.Contracts -->
- <class name="Contracts" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="checkNotNull" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ref" type="java.lang.Object"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check that a reference is not null.
- @param <T> type of the reference
- @param ref the reference to check
- @param msg the error message
- @throws NullPointerException if {@code ref} is null
- @return the checked reference for convenience]]>
- </doc>
- </method>
- <method name="checkState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check the state expression for false conditions
- @param expression the boolean expression to check
- @param msg the error message if {@code expression} is false
- @throws IllegalStateException if {@code expression} is false]]>
- </doc>
- </method>
- <method name="checkArg" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg" type="java.lang.Object"/>
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check an argument for false conditions
- @param <T> type of the argument
- @param arg the argument to check
- @param expression the boolean expression for the condition
- @param msg the error message if {@code expression} is false
- @return the argument for convenience]]>
- </doc>
- </method>
- <method name="checkArg" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg" type="int"/>
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check an argument for false conditions
- @param arg the argument to check
- @param expression the boolean expression for the condition
- @param msg the error message if {@code expression} is false
- @return the argument for convenience]]>
- </doc>
- </method>
- <method name="checkArg" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg" type="long"/>
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check an argument for false conditions
- @param arg the argument to check
- @param expression the boolean expression for the condition
- @param msg the error message if {@code expression} is false
- @return the argument for convenience]]>
- </doc>
- </method>
- <method name="checkArg" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg" type="float"/>
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check an argument for false conditions
- @param arg the argument to check
- @param expression the boolean expression for the condition
- @param msg the error message if {@code expression} is false
- @return the argument for convenience]]>
- </doc>
- </method>
- <method name="checkArg" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg" type="double"/>
- <param name="expression" type="boolean"/>
- <param name="msg" type="java.lang.Object"/>
- <doc>
- <![CDATA[Check an argument for false conditions
- @param arg the argument to check
- @param expression the boolean expression for the condition
- @param msg the error message if {@code expression} is false
- @return the argument for convenience]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Utilities for programming by contract (preconditions, postconditions etc.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.Contracts -->
- <!-- start class org.apache.hadoop.metrics2.util.MBeans -->
- <class name="MBeans" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MBeans"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="register" return="javax.management.ObjectName"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serviceName" type="java.lang.String"/>
- <param name="nameName" type="java.lang.String"/>
- <param name="theMbean" type="java.lang.Object"/>
- <doc>
- <![CDATA[Register the MBean using our standard MBeanName format
- "hadoop:service=<serviceName>,name=<nameName>"
- Where the <serviceName> and <nameName> are the supplied parameters
- @param serviceName
- @param nameName
- @param theMbean - the MBean to register
- @return the named used to register the MBean]]>
- </doc>
- </method>
- <method name="unregister"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mbeanName" type="javax.management.ObjectName"/>
- </method>
- <doc>
- <![CDATA[This util class provides a method to register an MBean using
- our standard naming convention as described in the doc
- for {link {@link #register(String, String, Object)}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.MBeans -->
- <!-- start class org.apache.hadoop.metrics2.util.MetricsCache -->
- <class name="MetricsCache" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsCache"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="update" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- <param name="includingTags" type="boolean"/>
- <doc>
- <![CDATA[Update the cache and return the cached record
- @param mr the update record
- @param includingTags cache tag values (for later lookup by name) if true
- @return the updated cached record]]>
- </doc>
- </method>
- <method name="update" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mr" type="org.apache.hadoop.metrics2.MetricsRecord"/>
- </method>
- <method name="get" return="org.apache.hadoop.metrics2.util.MetricsCache.Record"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="tags" type="java.util.Collection"/>
- <doc>
- <![CDATA[Get the cached record
- @param name of the record
- @param tags of the record
- @return the cached record or null]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A metrics cache for sinks that don't support sparse updates.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.MetricsCache -->
- <!-- start class org.apache.hadoop.metrics2.util.MetricsCache.Record -->
- <class name="MetricsCache.Record" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MetricsCache.Record"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTag" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the tag value
- @param key name of the tag
- @return the tag value]]>
- </doc>
- </method>
- <method name="getMetric" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the metric value
- @param key name of the metric
- @return the metric value]]>
- </doc>
- </method>
- <method name="getMetricInstance" return="org.apache.hadoop.metrics2.Metric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the metric value
- @param key name of the metric
- @return the metric value]]>
- </doc>
- </method>
- <method name="metrics" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return entry set of metrics]]>
- </doc>
- </method>
- <method name="metricsEntrySet" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return entry set of metrics]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Cached record]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.MetricsCache.Record -->
- <!-- start class org.apache.hadoop.metrics2.util.SampleStat -->
- <class name="SampleStat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SampleStat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new running sample stat]]>
- </doc>
- </constructor>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="copyTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.metrics2.util.SampleStat"/>
- <doc>
- <![CDATA[Copy the values to other (saves object creation and gc.)
- @param other the destination to hold our values]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.util.SampleStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="x" type="double"/>
- <doc>
- <![CDATA[Add a sample the running stat.
- @param x the sample number
- @return self]]>
- </doc>
- </method>
- <method name="add" return="org.apache.hadoop.metrics2.util.SampleStat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nSamples" type="long"/>
- <param name="x" type="double"/>
- <doc>
- <![CDATA[Add some sample and a partial sum to the running stat.
- Note, min/max is not evaluated using this method.
- @param nSamples number of samples
- @param x the partial sum
- @return self]]>
- </doc>
- </method>
- <method name="numSamples" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the total number of samples]]>
- </doc>
- </method>
- <method name="mean" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the arithmetic mean of the samples]]>
- </doc>
- </method>
- <method name="variance" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the variance of the samples]]>
- </doc>
- </method>
- <method name="stddev" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the standard deviation of the samples]]>
- </doc>
- </method>
- <method name="min" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the minimum value of the samples]]>
- </doc>
- </method>
- <method name="max" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the maximum value of the samples]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helper to compute running sample stats]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.SampleStat -->
- <!-- start class org.apache.hadoop.metrics2.util.SampleStat.MinMax -->
- <class name="SampleStat.MinMax" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SampleStat.MinMax"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="double"/>
- </method>
- <method name="min" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="max" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.metrics2.util.SampleStat.MinMax"/>
- </method>
- <doc>
- <![CDATA[Helper to keep running min/max]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.SampleStat.MinMax -->
- <!-- start class org.apache.hadoop.metrics2.util.Servers -->
- <class name="Servers" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="parse" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="specs" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Parses a space and/or comma separated sequence of server specifications
- of the form <i>hostname</i> or <i>hostname:port</i>. If
- the specs string is null, defaults to localhost:defaultPort.
- @param specs server specs (see description)
- @param defaultPort the default port if not specified
- @return a list of InetSocketAddress objects.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helpers to handle server addresses]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.Servers -->
- <!-- start class org.apache.hadoop.metrics2.util.TryIterator -->
- <class name="TryIterator" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Iterator"/>
- <constructor name="TryIterator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="tryNext" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the next element. Must call {@link #done()} when done, otherwise
- infinite loop could occur. If this method throws an exception, any
- further attempts to use the iterator would result in an
- {@link IllegalStateException}.
- @return the next element if there is one or return {@link #done()}]]>
- </doc>
- </method>
- <method name="done" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Implementations of {@link #tryNext} <b>must</b> call this method
- when there are no more elements left in the iteration.
- @return null as a convenience to implement {@link #tryNext()}]]>
- </doc>
- </method>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if we have a next element or false otherwise.]]>
- </doc>
- </method>
- <method name="next" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the next element if we have one.]]>
- </doc>
- </method>
- <method name="current" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the current element without advancing the iterator]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Guaranteed to throw UnsupportedOperationException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A base class for unmodifiable iterators (throws on remove)
- This class also makes writing filtering iterators easier, where the only
- way to discover the end of data is by trying to read it. The same applies
- to writing iterator wrappers around stream read calls.
- One only needs to implement the tryNext() method and call done() when done.
- @param <T> the type of the iterator]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.metrics2.util.TryIterator -->
- </package>
- <package name="org.apache.hadoop.net">
- <!-- start class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
- <class name="CachedDNSToSwitchMapping" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.net.DNSToSwitchMapping"/>
- <constructor name="CachedDNSToSwitchMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="resolve" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- </method>
- <field name="rawMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A cached implementation of DNSToSwitchMapping that takes an
- raw DNSToSwitchMapping and stores the resolved network location in
- a cache. The following calls to a resolved network location
- will get its location from the cache.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
- <!-- start class org.apache.hadoop.net.DNS -->
- <class name="DNS" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DNS"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reverseDns" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostIp" type="java.net.InetAddress"/>
- <param name="ns" type="java.lang.String"/>
- <exception name="NamingException" type="javax.naming.NamingException"/>
- <doc>
- <![CDATA[Returns the hostname associated with the specified IP address by the
- provided nameserver.
-
- @param hostIp
- The address to reverse lookup
- @param ns
- The host name of a reachable DNS server
- @return The host name associated with the provided IP
- @throws NamingException
- If a NamingException is encountered]]>
- </doc>
- </method>
- <method name="getIPs" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Like {@link DNS#getIPs(String, boolean)}, but returns all
- IPs associated with the given interface and its subinterfaces.]]>
- </doc>
- </method>
- <method name="getIPs" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <param name="returnSubinterfaces" type="boolean"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns all the IPs associated with the provided interface, if any, in
- textual form.
-
- @param strInterface
- The name of the network interface or subinterface to query
- (eg eth0 or eth0:0) or the string "default"
- @param returnSubinterfaces
- Whether to return IPs associated with subinterfaces of
- the given interface
- @return A string vector of all the IPs associated with the provided
- interface
- @throws UnknownHostException
- If an UnknownHostException is encountered in querying the
- default interface or the given interface can not be found]]>
- </doc>
- </method>
- <method name="getDefaultIP" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns the first available IP address associated with the provided
- network interface
-
- @param strInterface
- The name of the network interface or subinterface to query
- (e.g. eth0 or eth0:0) or the string "default"
- @return The IP address in text form
- @throws UnknownHostException
- If one is encountered in querying the default interface]]>
- </doc>
- </method>
- <method name="getHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <param name="nameserver" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns all the host names associated by the provided nameserver with the
- address bound to the specified network interface
-
- @param strInterface
- The name of the network interface or subinterface to query
- (e.g. eth0 or eth0:0) or the string "default"
- @param nameserver
- The DNS host name
- @return A string vector of all host names associated with the IPs tied to
- the specified interface
- @throws UnknownHostException]]>
- </doc>
- </method>
- <method name="getHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns all the host names associated by the default nameserver with the
- address bound to the specified network interface
-
- @param strInterface
- The name of the network interface to query (e.g. eth0)
- @return The list of host names associated with IPs bound to the network
- interface
- @throws UnknownHostException
- If one is encountered while querying the deault interface]]>
- </doc>
- </method>
- <method name="getDefaultHost" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <param name="nameserver" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns the default (first) host name associated by the provided
- nameserver with the address bound to the specified network interface
-
- @param strInterface
- The name of the network interface to query (e.g. eth0)
- @param nameserver
- The DNS host name
- @return The default host names associated with IPs bound to the network
- interface
- @throws UnknownHostException
- If one is encountered while querying the deault interface]]>
- </doc>
- </method>
- <method name="getDefaultHost" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strInterface" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Returns the default (first) host name associated by the default
- nameserver with the address bound to the specified network interface
-
- @param strInterface
- The name of the network interface to query (e.g. eth0)
- @return The default host name associated with IPs bound to the network
- interface
- @throws UnknownHostException
- If one is encountered while querying the deault interface]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A class that provides direct and reverse lookup functionalities, allowing
- the querying of specific network interfaces or nameservers.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.DNS -->
- <!-- start interface org.apache.hadoop.net.DNSToSwitchMapping -->
- <interface name="DNSToSwitchMapping" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="resolve" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.List"/>
- <doc>
- <![CDATA[Resolves a list of DNS-names/IP-addresses and returns back a list of
- switch information (network paths). One-to-one correspondence must be
- maintained between the elements in the lists.
- Consider an element in the argument list - x.y.com. The switch information
- that is returned must be a network path of the form /foo/rack,
- where / is the root, and 'foo' is the switch where 'rack' is connected.
- Note the hostname/ip-address is not part of the returned path.
- The network topology of the cluster would determine the number of
- components in the network path.
- @param names
- @return list of resolved network paths]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An interface that should be implemented to allow pluggable
- DNS-name/IP-address to RackID resolvers.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.net.DNSToSwitchMapping -->
- <!-- start class org.apache.hadoop.net.NetUtils -->
- <class name="NetUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NetUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSocketFactory" return="javax.net.SocketFactory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the socket factory for the given class according to its
- configuration parameter
- <tt>hadoop.rpc.socket.factory.class.<ClassName></tt>. When no
- such parameter exists then fall back on the default socket factory as
- configured by <tt>hadoop.rpc.socket.factory.class.default</tt>. If
- this default socket factory is not configured, then fall back on the JVM
- default socket factory.
-
- @param conf the configuration
- @param clazz the class (usually a {@link VersionedProtocol})
- @return a socket factory]]>
- </doc>
- </method>
- <method name="getDefaultSocketFactory" return="javax.net.SocketFactory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the default socket factory as specified by the configuration
- parameter <tt>hadoop.rpc.socket.factory.default</tt>
-
- @param conf the configuration
- @return the default socket factory as specified in the configuration or
- the JVM default socket factory if the configuration does not
- contain a default socket factory property.]]>
- </doc>
- </method>
- <method name="getSocketFactoryFromProperty" return="javax.net.SocketFactory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="propValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the socket factory corresponding to the given proxy URI. If the
- given proxy URI corresponds to an absence of configuration parameter,
- returns null. If the URI is malformed raises an exception.
-
- @param propValue the property which is the class name of the
- SocketFactory to instantiate; assumed non null and non empty.
- @return a socket factory as defined in the property value.]]>
- </doc>
- </method>
- <method name="createSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="java.lang.String"/>
- <doc>
- <![CDATA[Util method to build socket addr from either:
- <host>:<post>
- <fs>://<host>:<port>/<path>]]>
- </doc>
- </method>
- <method name="createSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="target" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Util method to build socket addr from either:
- <host>
- <host>:<post>
- <fs>://<host>:<port>/<path>]]>
- </doc>
- </method>
- <method name="makeSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Create a socket address with the given host and port. The hostname
- might be replaced with another host that was set via
- {@link #addStaticResolution(String, String)}. The value of
- hadoop.security.token.service.use_ip will determine whether the
- standard java host resolver is used, or if the fully qualified resolver
- is used.
- @param host the hostname or IP use to instantiate the object
- @param port the port number
- @return InetSocketAddress]]>
- </doc>
- </method>
- <method name="getCanonicalUri" return="java.net.URI"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Resolve the uri's hostname and add the default port if not in the uri
- @param uri to resolve
- @param defaultPort if none is given
- @return URI
- @throws UnknownHostException]]>
- </doc>
- </method>
- <method name="getServerAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="oldBindAddressName" type="java.lang.String"/>
- <param name="oldPortName" type="java.lang.String"/>
- <param name="newBindAddressName" type="java.lang.String"/>
- <doc>
- <![CDATA[Handle the transition from pairs of attributes specifying a host and port
- to a single colon separated one.
- @param conf the configuration to check
- @param oldBindAddressName the old address attribute name
- @param oldPortName the old port attribute name
- @param newBindAddressName the new combined name
- @return the complete address from the configuration]]>
- </doc>
- </method>
- <method name="addStaticResolution"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="resolvedName" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds a static resolution for host. This can be used for setting up
- hostnames with names that are fake to point to a well known host. For e.g.
- in some testcases we require to have daemons with different hostnames
- running on the same machine. In order to create connections to these
- daemons, one can set up mappings from those hostnames to "localhost".
- {@link NetUtils#getStaticResolution(String)} can be used to query for
- the actual hostname.
- @param host
- @param resolvedName]]>
- </doc>
- </method>
- <method name="getStaticResolution" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <doc>
- <![CDATA[Retrieves the resolved name for the passed host. The resolved name must
- have been set earlier using
- {@link NetUtils#addStaticResolution(String, String)}
- @param host
- @return the resolution]]>
- </doc>
- </method>
- <method name="getAllStaticResolutions" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This is used to get all the resolutions that were added using
- {@link NetUtils#addStaticResolution(String, String)}. The return
- value is a List each element of which contains an array of String
- of the form String[0]=hostname, String[1]=resolved-hostname
- @return the list of resolutions]]>
- </doc>
- </method>
- <method name="getConnectAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="server" type="org.apache.hadoop.ipc.Server"/>
- <doc>
- <![CDATA[Returns InetSocketAddress that a client can use to
- connect to the server. Server.getListenerAddress() is not correct when
- the server binds to "0.0.0.0". This returns "127.0.0.1:port" when
- the getListenerAddress() returns "0.0.0.0:port".
-
- @param server
- @return socket address that a client can use to connect to the server.]]>
- </doc>
- </method>
- <method name="getInputStream" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as getInputStream(socket, socket.getSoTimeout()).<br><br>
-
- From documentation for {@link #getInputStream(Socket, long)}:<br>
- Returns InputStream for the socket. If the socket has an associated
- SocketChannel then it returns a
- {@link SocketInputStream} with the given timeout. If the socket does not
- have a channel, {@link Socket#getInputStream()} is returned. In the later
- case, the timeout argument is ignored and the timeout set with
- {@link Socket#setSoTimeout(int)} applies for reads.<br><br>
- Any socket created using socket factories returned by {@link NetUtils},
- must use this interface instead of {@link Socket#getInputStream()}.
-
- @see #getInputStream(Socket, long)
-
- @param socket
- @return InputStream for reading from the socket.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getInputStream" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <param name="timeout" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns InputStream for the socket. If the socket has an associated
- SocketChannel then it returns a
- {@link SocketInputStream} with the given timeout. If the socket does not
- have a channel, {@link Socket#getInputStream()} is returned. In the later
- case, the timeout argument is ignored and the timeout set with
- {@link Socket#setSoTimeout(int)} applies for reads.<br><br>
-
- Any socket created using socket factories returned by {@link NetUtils},
- must use this interface instead of {@link Socket#getInputStream()}.
-
- @see Socket#getChannel()
-
- @param socket
- @param timeout timeout in milliseconds. This may not always apply. zero
- for waiting as long as necessary.
- @return InputStream for reading from the socket.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as getOutputStream(socket, 0). Timeout of zero implies write will
- wait until data is available.<br><br>
-
- From documentation for {@link #getOutputStream(Socket, long)} : <br>
- Returns OutputStream for the socket. If the socket has an associated
- SocketChannel then it returns a
- {@link SocketOutputStream} with the given timeout. If the socket does not
- have a channel, {@link Socket#getOutputStream()} is returned. In the later
- case, the timeout argument is ignored and the write will wait until
- data is available.<br><br>
-
- Any socket created using socket factories returned by {@link NetUtils},
- must use this interface instead of {@link Socket#getOutputStream()}.
-
- @see #getOutputStream(Socket, long)
-
- @param socket
- @return OutputStream for writing to the socket.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <param name="timeout" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns OutputStream for the socket. If the socket has an associated
- SocketChannel then it returns a
- {@link SocketOutputStream} with the given timeout. If the socket does not
- have a channel, {@link Socket#getOutputStream()} is returned. In the later
- case, the timeout argument is ignored and the write will wait until
- data is available.<br><br>
-
- Any socket created using socket factories returned by {@link NetUtils},
- must use this interface instead of {@link Socket#getOutputStream()}.
-
- @see Socket#getChannel()
-
- @param socket
- @param timeout timeout in milliseconds. This may not always apply. zero
- for waiting as long as necessary.
- @return OutputStream for writing to the socket.
- @throws IOException]]>
- </doc>
- </method>
- <method name="connect"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <param name="address" type="java.net.SocketAddress"/>
- <param name="timeout" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This is a drop-in replacement for
- {@link Socket#connect(SocketAddress, int)}.
- In the case of normal sockets that don't have associated channels, this
- just invokes <code>socket.connect(endpoint, timeout)</code>. If
- <code>socket.getChannel()</code> returns a non-null channel,
- connect is implemented using Hadoop's selectors. This is done mainly
- to avoid Sun's connect implementation from creating thread-local
- selectors, since Hadoop does not have control on when these are closed
- and could end up taking all the available file descriptors.
-
- @see java.net.Socket#connect(java.net.SocketAddress, int)
-
- @param socket
- @param address the remote address
- @param timeout timeout in milliseconds]]>
- </doc>
- </method>
- <method name="connect"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="socket" type="java.net.Socket"/>
- <param name="endpoint" type="java.net.SocketAddress"/>
- <param name="localAddr" type="java.net.SocketAddress"/>
- <param name="timeout" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Like {@link NetUtils#connect(Socket, SocketAddress, int)} but
- also takes a local address and port to bind the socket to.
-
- @param socket
- @param endpoint the remote address
- @param localAddr the local address to bind the socket to
- @param timeout timeout in milliseconds]]>
- </doc>
- </method>
- <method name="normalizeHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a string representation of a host, return its ip address
- in textual presentation.
-
- @param name a string representation of a host:
- either a textual representation its IP address or its host name
- @return its IP address in the string format]]>
- </doc>
- </method>
- <method name="normalizeHostNames" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.util.Collection"/>
- <doc>
- <![CDATA[Given a collection of string representation of hosts, return a list of
- corresponding IP addresses in the textual representation.
-
- @param names a collection of string representations of hosts
- @return a list of corresponding IP addresses in the string format
- @see #normalizeHostName(String)]]>
- </doc>
- </method>
- <method name="verifyHostnames"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="names" type="java.lang.String[]"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Performs a sanity check on the list of hostnames/IPs to verify they at least
- appear to be valid.
- @param names - List of hostnames/IPs
- @throws UnknownHostException]]>
- </doc>
- </method>
- <method name="getLocalInetAddress" return="java.net.InetAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <exception name="SocketException" type="java.net.SocketException"/>
- <doc>
- <![CDATA[Checks if {@code host} is a local host name and return {@link InetAddress}
- corresponding to that address.
-
- @param host the specified host
- @return a valid local {@link InetAddress} or null
- @throws SocketException if an I/O error occurs]]>
- </doc>
- </method>
- <method name="isValidSubnet" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subnet" type="java.lang.String"/>
- <doc>
- <![CDATA[@return true if the given string is a subnet specified
- using CIDR notation, false otherwise]]>
- </doc>
- </method>
- <method name="getIPs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subnet" type="java.lang.String"/>
- <param name="returnSubinterfaces" type="boolean"/>
- <doc>
- <![CDATA[Return an InetAddress for each interface that matches the
- given subnet specified using CIDR notation.
- @param subnet subnet specified using CIDR notation
- @param returnSubinterfaces
- whether to return IPs associated with subinterfaces
- @throws IllegalArgumentException if subnet is invalid]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.net.NetUtils -->
- <!-- start class org.apache.hadoop.net.NetworkTopology -->
- <class name="NetworkTopology" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NetworkTopology"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.net.NetworkTopology"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get an instance of NetworkTopology based on the value of the configuration
- parameter net.topology.impl.
-
- @param conf the configuration to be used
- @return an instance of NetworkTopology]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Add a leaf node
- Update node counter & rack counter if neccessary
- @param node
- node to be added
- @exception IllegalArgumentException if add a node to a leave
- or node to be added is not a leaf]]>
- </doc>
- </method>
- <method name="getNodeForNetworkLocation" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Return a reference to the node given its string representation.
- Default implementation delegates to {@link #getNode(String)}.
-
- <p>To be overridden in subclasses for specific NetworkTopology
- implementations, as alternative to overriding the full {@link #add(Node)}
- method.
-
- @param node The string representation of this node's network location is
- used to retrieve a Node object.
- @return a reference to the node; null if the node is not in the tree
-
- @see #add(Node)
- @see #getNode(String)]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Remove a node
- Update node counter & rack counter if neccessary
- @param node
- node to be removed]]>
- </doc>
- </method>
- <method name="contains" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Check if the tree contains node <i>node</i>
-
- @param node
- a node
- @return true if <i>node</i> is already in the tree; false otherwise]]>
- </doc>
- </method>
- <method name="getNode" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="loc" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a string representation of a node, return its reference
-
- @param loc
- a path-like string representation of a node
- @return a reference to the node; null if the node is not in the tree]]>
- </doc>
- </method>
- <method name="getRack" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="loc" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a string representation of a rack for a specific network
- location
-
- To be overridden in subclasses for specific NetworkTopology
- implementations, as alternative to overriding the full
- {@link #getRack(String)} method.
- @param loc
- a path-like string representation of a network location
- @return a rack string]]>
- </doc>
- </method>
- <method name="getNumOfRacks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the total number of racks]]>
- </doc>
- </method>
- <method name="getNumOfLeaves" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the total number of nodes]]>
- </doc>
- </method>
- <method name="getDistance" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Return the distance between two nodes
- It is assumed that the distance from one node to its parent is 1
- The distance between two nodes is calculated by summing up their distances
- to their closest common ancestor.
- @param node1 one node
- @param node2 another node
- @return the distance between node1 and node2
- node1 or node2 do not belong to the cluster]]>
- </doc>
- </method>
- <method name="isOnSameRack" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Check if two nodes are on the same rack
- @param node1 one node
- @param node2 another node
- @return true if node1 and node2 are pm the same rack; false otherwise
- @exception IllegalArgumentException when either node1 or node2 is null, or
- node1 or node2 do not belong to the cluster]]>
- </doc>
- </method>
- <method name="isNodeGroupAware" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check if network topology is aware of NodeGroup]]>
- </doc>
- </method>
- <method name="isOnSameNodeGroup" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Return false directly as not aware of NodeGroup, to be override in sub-class]]>
- </doc>
- </method>
- <method name="isSameParents" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Compare the parents of each node for equality
-
- <p>To be overridden in subclasses for specific NetworkTopology
- implementations, as alternative to overriding the full
- {@link #isOnSameRack(Node, Node)} method.
-
- @param node1 the first node to compare
- @param node2 the second node to compare
- @return true if their parents are equal, false otherwise
-
- @see #isOnSameRack(Node, Node)]]>
- </doc>
- </method>
- <method name="chooseRandom" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <doc>
- <![CDATA[randomly choose one node from <i>scope</i>
- if scope starts with ~, choose one from the all nodes except for the
- ones in <i>scope</i>; otherwise, choose one from <i>scope</i>
- @param scope range of nodes from which a node will be choosen
- @return the choosen node]]>
- </doc>
- </method>
- <method name="getLeaves" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <doc>
- <![CDATA[return leaves in <i>scope</i>
- @param scope a path string
- @return leaves nodes under specific scope]]>
- </doc>
- </method>
- <method name="countNumOfAvailableNodes" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="excludedNodes" type="java.util.Collection"/>
- <doc>
- <![CDATA[return the number of leaves in <i>scope</i> but not in <i>excludedNodes</i>
- if scope starts with ~, return the number of nodes that are not
- in <i>scope</i> and <i>excludedNodes</i>;
- @param scope a path string that may start with ~
- @param excludedNodes a list of nodes
- @return number of available nodes]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[convert a network tree to a string]]>
- </doc>
- </method>
- <method name="getFirstHalf" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="networkLocation" type="java.lang.String"/>
- <doc>
- <![CDATA[Divide networklocation string into two parts by last separator, and get the
- first part here.
-
- @param networkLocation
- @return]]>
- </doc>
- </method>
- <method name="getLastHalf" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="networkLocation" type="java.lang.String"/>
- <doc>
- <![CDATA[Divide networklocation string into two parts by last separator, and get the
- second part here.
-
- @param networkLocation
- @return]]>
- </doc>
- </method>
- <method name="swap"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="nodes" type="org.apache.hadoop.net.Node[]"/>
- <param name="i" type="int"/>
- <param name="j" type="int"/>
- </method>
- <method name="pseudoSortByDistance"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reader" type="org.apache.hadoop.net.Node"/>
- <param name="nodes" type="org.apache.hadoop.net.Node[]"/>
- <doc>
- <![CDATA[Sort nodes array by their distances to <i>reader</i>
- It linearly scans the array, if a local node is found, swap it with
- the first element of the array.
- If a local rack node is found, swap it with the first element following
- the local node.
- If neither local node or local rack node is found, put a random replica
- location at postion 0.
- It leaves the rest nodes untouched.]]>
- </doc>
- </method>
- <field name="DEFAULT_RACK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_HOST_LEVEL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="numOfRacks" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="netlock" type="java.util.concurrent.locks.ReadWriteLock"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="r" type="java.util.Random"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The class represents a cluster of computer with a tree hierarchical
- network topology.
- For example, a cluster may be consists of many data centers filled
- with racks of computers.
- In a network topology, leaves represent data nodes (computers) and inner
- nodes represent switches/routers that manage traffic in/out of data centers
- or racks.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.NetworkTopology -->
- <!-- start class org.apache.hadoop.net.NetworkTopology.InvalidTopologyException -->
- <class name="NetworkTopology.InvalidTopologyException" extends="java.lang.RuntimeException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NetworkTopology.InvalidTopologyException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.net.NetworkTopology.InvalidTopologyException -->
- <!-- start class org.apache.hadoop.net.NetworkTopologyWithNodeGroup -->
- <class name="NetworkTopologyWithNodeGroup" extends="org.apache.hadoop.net.NetworkTopology"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NetworkTopologyWithNodeGroup"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeForNetworkLocation" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- </method>
- <method name="getRack" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="loc" type="java.lang.String"/>
- </method>
- <method name="getNodeGroup" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="loc" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a string representation of a node group for a specific network
- location
-
- @param loc
- a path-like string representation of a network location
- @return a node group string]]>
- </doc>
- </method>
- <method name="isOnSameRack" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- </method>
- <method name="isOnSameNodeGroup" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node1" type="org.apache.hadoop.net.Node"/>
- <param name="node2" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Check if two nodes are on the same node group (hypervisor) The
- assumption here is: each nodes are leaf nodes.
-
- @param node1
- one node (can be null)
- @param node2
- another node (can be null)
- @return true if node1 and node2 are on the same node group; false
- otherwise
- @exception IllegalArgumentException
- when either node1 or node2 is null, or node1 or node2 do
- not belong to the cluster]]>
- </doc>
- </method>
- <method name="isNodeGroupAware" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check if network topology is aware of NodeGroup]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Add a leaf node
- Update node counter & rack counter if necessary
- @param node node to be added; can be null
- @exception IllegalArgumentException if add a node to a leave
- or node to be added is not a leaf]]>
- </doc>
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Remove a node
- Update node counter and rack counter if necessary
- @param node node to be removed; can be null]]>
- </doc>
- </method>
- <method name="pseudoSortByDistance"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reader" type="org.apache.hadoop.net.Node"/>
- <param name="nodes" type="org.apache.hadoop.net.Node[]"/>
- <doc>
- <![CDATA[Sort nodes array by their distances to <i>reader</i>
- It linearly scans the array, if a local node is found, swap it with
- the first element of the array.
- If a local node group node is found, swap it with the first element
- following the local node.
- If a local rack node is found, swap it with the first element following
- the local node group node.
- If neither local node, node group node or local rack node is found, put a
- random replica location at position 0.
- It leaves the rest nodes untouched.
- @param reader the node that wishes to read a block from one of the nodes
- @param nodes the list of nodes containing data for the reader]]>
- </doc>
- </method>
- <field name="DEFAULT_NODEGROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The class extends NetworkTopology to represents a cluster of computer with
- a 4-layers hierarchical network topology.
- In this network topology, leaves represent data nodes (computers) and inner
- nodes represent switches/routers that manage traffic in/out of data centers,
- racks or physical host (with virtual switch).
-
- @see NetworkTopology]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.NetworkTopologyWithNodeGroup -->
- <!-- start interface org.apache.hadoop.net.Node -->
- <interface name="Node" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getNetworkLocation" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the string representation of this node's network location]]>
- </doc>
- </method>
- <method name="setNetworkLocation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="location" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the node's network location]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's name]]>
- </doc>
- </method>
- <method name="getParent" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's parent]]>
- </doc>
- </method>
- <method name="setParent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parent" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Set this node's parent]]>
- </doc>
- </method>
- <method name="getLevel" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's level in the tree.
- E.g. the root of a tree returns 0 and its children return 1]]>
- </doc>
- </method>
- <method name="setLevel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Set this node's level in the tree.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The interface defines a node in a network topology.
- A node may be a leave representing a data node or an inner
- node representing a datacenter or rack.
- Each data has a name and its location in the network is
- decided by a string with syntax similar to a file name.
- For example, a data node's name is hostname:port# and if it's located at
- rack "orange" in datacenter "dog", the string representation of its
- network location is /dog/orange]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.net.Node -->
- <!-- start class org.apache.hadoop.net.NodeBase -->
- <class name="NodeBase" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.net.Node"/>
- <constructor name="NodeBase"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor]]>
- </doc>
- </constructor>
- <constructor name="NodeBase" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a node from its path
- @param path
- a concatenation of this node's location, the path seperator, and its name]]>
- </doc>
- </constructor>
- <constructor name="NodeBase" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a node from its name and its location
- @param name this node's name
- @param location this node's location]]>
- </doc>
- </constructor>
- <constructor name="NodeBase" type="java.lang.String, java.lang.String, org.apache.hadoop.net.Node, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a node from its name and its location
- @param name this node's name
- @param location this node's location
- @param parent this node's parent node
- @param level this node's level in the tree]]>
- </doc>
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's name]]>
- </doc>
- </method>
- <method name="getNetworkLocation" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's network location]]>
- </doc>
- </method>
- <method name="setNetworkLocation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="location" type="java.lang.String"/>
- <doc>
- <![CDATA[Set this node's network location]]>
- </doc>
- </method>
- <method name="getPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Return this node's path]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's string representation]]>
- </doc>
- </method>
- <method name="normalize" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <doc>
- <![CDATA[Normalize a path]]>
- </doc>
- </method>
- <method name="getParent" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's parent]]>
- </doc>
- </method>
- <method name="setParent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parent" type="org.apache.hadoop.net.Node"/>
- <doc>
- <![CDATA[Set this node's parent]]>
- </doc>
- </method>
- <method name="getLevel" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this node's level in the tree.
- E.g. the root of a tree returns 0 and its children return 1]]>
- </doc>
- </method>
- <method name="setLevel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="level" type="int"/>
- <doc>
- <![CDATA[Set this node's level in the tree]]>
- </doc>
- </method>
- <field name="PATH_SEPARATOR" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PATH_SEPARATOR_STR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROOT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="name" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="location" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="level" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="parent" type="org.apache.hadoop.net.Node"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A base class that implements interface Node]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.NodeBase -->
- <!-- start class org.apache.hadoop.net.ScriptBasedMapping -->
- <class name="ScriptBasedMapping" extends="org.apache.hadoop.net.CachedDNSToSwitchMapping"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="ScriptBasedMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ScriptBasedMapping" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[This class implements the {@link DNSToSwitchMapping} interface using a
- script configured via topology.script.file.name .]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.ScriptBasedMapping -->
- <!-- start class org.apache.hadoop.net.SocketInputStream -->
- <class name="SocketInputStream" extends="java.io.InputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.nio.channels.ReadableByteChannel"/>
- <constructor name="SocketInputStream" type="java.nio.channels.ReadableByteChannel, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new input stream with the given timeout. If the timeout
- is zero, it will be treated as infinite timeout. The socket's
- channel will be configured to be non-blocking.
-
- @param channel
- Channel for reading, should also be a {@link SelectableChannel}.
- The channel will be configured to be non-blocking.
- @param timeout timeout in milliseconds. must not be negative.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="SocketInputStream" type="java.net.Socket, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as SocketInputStream(socket.getChannel(), timeout): <br><br>
-
- Create a new input stream with the given timeout. If the timeout
- is zero, it will be treated as infinite timeout. The socket's
- channel will be configured to be non-blocking.
-
- @see SocketInputStream#SocketInputStream(ReadableByteChannel, long)
-
- @param socket should have a channel associated with it.
- @param timeout timeout timeout in milliseconds. must not be negative.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="SocketInputStream" type="java.net.Socket"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as SocketInputStream(socket.getChannel(), socket.getSoTimeout())
- :<br><br>
-
- Create a new input stream with the given timeout. If the timeout
- is zero, it will be treated as infinite timeout. The socket's
- channel will be configured to be non-blocking.
- @see SocketInputStream#SocketInputStream(ReadableByteChannel, long)
-
- @param socket should have a channel associated with it.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getChannel" return="java.nio.channels.ReadableByteChannel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns underlying channel used by inputstream.
- This is useful in certain cases like channel for
- {@link FileChannel#transferFrom(ReadableByteChannel, long, long)}.]]>
- </doc>
- </method>
- <method name="isOpen" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dst" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="waitForReadable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[waits for the underlying channel to be ready for reading.
- The timeout specified for this stream applies to this wait.
-
- @throws SocketTimeoutException
- if select on the channel times out.
- @throws IOException
- if any other I/O error occurs.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This implements an input stream that can have a timeout while reading.
- This sets non-blocking flag on the socket channel.
- So after create this object, read() on
- {@link Socket#getInputStream()} and write() on
- {@link Socket#getOutputStream()} for the associated socket will throw
- IllegalBlockingModeException.
- Please use {@link SocketOutputStream} for writing.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.SocketInputStream -->
- <!-- start class org.apache.hadoop.net.SocketOutputStream -->
- <class name="SocketOutputStream" extends="java.io.OutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.nio.channels.WritableByteChannel"/>
- <constructor name="SocketOutputStream" type="java.nio.channels.WritableByteChannel, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a new ouput stream with the given timeout. If the timeout
- is zero, it will be treated as infinite timeout. The socket's
- channel will be configured to be non-blocking.
-
- @param channel
- Channel for writing, should also be a {@link SelectableChannel}.
- The channel will be configured to be non-blocking.
- @param timeout timeout in milliseconds. must not be negative.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="SocketOutputStream" type="java.net.Socket, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Same as SocketOutputStream(socket.getChannel(), timeout):<br><br>
-
- Create a new ouput stream with the given timeout. If the timeout
- is zero, it will be treated as infinite timeout. The socket's
- channel will be configured to be non-blocking.
-
- @see SocketOutputStream#SocketOutputStream(WritableByteChannel, long)
-
- @param socket should have a channel associated with it.
- @param timeout timeout timeout in milliseconds. must not be negative.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getChannel" return="java.nio.channels.WritableByteChannel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns underlying channel used by this stream.
- This is useful in certain cases like channel for
- {@link FileChannel#transferTo(long, long, WritableByteChannel)}]]>
- </doc>
- </method>
- <method name="isOpen" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="java.nio.ByteBuffer"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="waitForWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[waits for the underlying channel to be ready for writing.
- The timeout specified for this stream applies to this wait.
- @throws SocketTimeoutException
- if select on the channel times out.
- @throws IOException
- if any other I/O error occurs.]]>
- </doc>
- </method>
- <method name="transferToFully"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileCh" type="java.nio.channels.FileChannel"/>
- <param name="position" type="long"/>
- <param name="count" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Transfers data from FileChannel using
- {@link FileChannel#transferTo(long, long, WritableByteChannel)}.
-
- Similar to readFully(), this waits till requested amount of
- data is transfered.
-
- @param fileCh FileChannel to transfer data from.
- @param position position within the channel where the transfer begins
- @param count number of bytes to transfer.
-
- @throws EOFException
- If end of input file is reached before requested number of
- bytes are transfered.
- @throws SocketTimeoutException
- If this channel blocks transfer longer than timeout for
- this stream.
-
- @throws IOException Includes any exception thrown by
- {@link FileChannel#transferTo(long, long, WritableByteChannel)}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This implements an output stream that can have a timeout while writing.
- This sets non-blocking flag on the socket channel.
- So after creating this object , read() on
- {@link Socket#getInputStream()} and write() on
- {@link Socket#getOutputStream()} on the associated socket will throw
- llegalBlockingModeException.
- Please use {@link SocketInputStream} for reading.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.SocketOutputStream -->
- <!-- start class org.apache.hadoop.net.SocksSocketFactory -->
- <class name="SocksSocketFactory" extends="javax.net.SocketFactory"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="SocksSocketFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default empty constructor (for use with the reflection API).]]>
- </doc>
- </constructor>
- <constructor name="SocksSocketFactory" type="java.net.Proxy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor with a supplied Proxy
-
- @param proxy the proxy to use to create sockets]]>
- </doc>
- </constructor>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.SocksSocketFactory -->
- <!-- start class org.apache.hadoop.net.StandardSocketFactory -->
- <class name="StandardSocketFactory" extends="javax.net.SocketFactory"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StandardSocketFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default empty constructor (for use with the reflection API).]]>
- </doc>
- </constructor>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetAddress"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="createSocket" return="java.net.Socket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="localHostAddr" type="java.net.InetAddress"/>
- <param name="localPort" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.net.StandardSocketFactory -->
- </package>
- <package name="org.apache.hadoop.record">
- <!-- start class org.apache.hadoop.record.BinaryRecordInput -->
- <class name="BinaryRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="BinaryRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordInput]]>
- </doc>
- </constructor>
- <constructor name="BinaryRecordInput" type="java.io.DataInput"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordInput]]>
- </doc>
- </constructor>
- <method name="get" return="org.apache.hadoop.record.BinaryRecordInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inp" type="java.io.DataInput"/>
- <doc>
- <![CDATA[Get a thread-local record input for the supplied DataInput.
- @param inp data input stream
- @return binary record input corresponding to the supplied DataInput.]]>
- </doc>
- </method>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.record.BinaryRecordInput -->
- <!-- start class org.apache.hadoop.record.BinaryRecordOutput -->
- <class name="BinaryRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="BinaryRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordOutput]]>
- </doc>
- </constructor>
- <constructor name="BinaryRecordOutput" type="java.io.DataOutput"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of BinaryRecordOutput]]>
- </doc>
- </constructor>
- <method name="get" return="org.apache.hadoop.record.BinaryRecordOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <doc>
- <![CDATA[Get a thread-local record output for the supplied DataOutput.
- @param out data output stream
- @return binary record output corresponding to the supplied DataOutput.]]>
- </doc>
- </method>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.record.BinaryRecordOutput -->
- <!-- start class org.apache.hadoop.record.Buffer -->
- <class name="Buffer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="Buffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a zero-count sequence.]]>
- </doc>
- </constructor>
- <constructor name="Buffer" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Buffer using the byte array as the initial value.
- @param bytes This array becomes the backing storage for the object.]]>
- </doc>
- </constructor>
- <constructor name="Buffer" type="byte[], int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Buffer using the byte range as the initial value.
- @param bytes Copy of this array becomes the backing storage for the object.
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Use the specified bytes array as underlying sequence.
- @param bytes byte sequence]]>
- </doc>
- </method>
- <method name="copy"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Copy the specified byte array to the Buffer. Replaces the current buffer.
- @param bytes byte array to be assigned
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </method>
- <method name="get" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data from the Buffer.
-
- @return The data is only valid between 0 and getCount() - 1.]]>
- </doc>
- </method>
- <method name="getCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current count of the buffer.]]>
- </doc>
- </method>
- <method name="getCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the capacity, which is the maximum count that could handled without
- resizing the backing storage.
-
- @return The number of bytes]]>
- </doc>
- </method>
- <method name="setCapacity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newCapacity" type="int"/>
- <doc>
- <![CDATA[Change the capacity of the backing storage.
- The data is preserved if newCapacity >= getCount().
- @param newCapacity The new capacity in bytes.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reset the buffer to 0 size]]>
- </doc>
- </method>
- <method name="truncate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Change the capacity of the backing store to be the same as the current
- count of buffer.]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <doc>
- <![CDATA[Append specified bytes to the buffer.
- @param bytes byte array to be appended
- @param offset offset into byte array
- @param length length of data]]>
- </doc>
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Append specified bytes to the buffer
- @param bytes byte array to be appended]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Define the sort order of the Buffer.
-
- @param other The other buffer
- @return Positive if this is bigger than other, 0 if they are equal, and
- negative if this is smaller than other.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="charsetName" type="java.lang.String"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- <doc>
- <![CDATA[Convert the byte buffer to a string an specific character encoding
- @param charsetName Valid Java Character Set Name]]>
- </doc>
- </method>
- <method name="clone" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="CloneNotSupportedException" type="java.lang.CloneNotSupportedException"/>
- </method>
- <doc>
- <![CDATA[A byte sequence that is used as a Java native type for buffer.
- It is resizable and distinguishes between the count of the seqeunce and
- the current capacity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Buffer -->
- <!-- start class org.apache.hadoop.record.CsvRecordInput -->
- <class name="CsvRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="CsvRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of CsvRecordInput]]>
- </doc>
- </constructor>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.record.CsvRecordInput -->
- <!-- start class org.apache.hadoop.record.CsvRecordOutput -->
- <class name="CsvRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="CsvRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of CsvRecordOutput]]>
- </doc>
- </constructor>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.record.CsvRecordOutput -->
- <!-- start interface org.apache.hadoop.record.Index -->
- <interface name="Index" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="done" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incr"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Interface that acts as an iterator for deserializing maps.
- The deserializer returns an instance that the record uses to
- read vectors and maps. An example of usage is as follows:
- <code>
- Index idx = startVector(...);
- while (!idx.done()) {
- .... // read element of a vector
- idx.incr();
- }
- </code>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.Index -->
- <!-- start class org.apache.hadoop.record.Record -->
- <class name="Record" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="Record"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="serialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a record with tag (ususally field name)
- @param rout Record output destination
- @param tag record tag (Used only in tagged serialization e.g. XML)]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize a record with a tag (usually field name)
- @param rin Record input source
- @param tag Record tag (Used only in tagged serialization e.g. XML)]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="peer" type="java.lang.Object"/>
- <exception name="ClassCastException" type="java.lang.ClassCastException"/>
- </method>
- <method name="serialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize a record without a tag
- @param rout Record output destination]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize a record without a tag
- @param rin Record input source]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="din" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Abstract class that is extended by generated classes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Record -->
- <!-- start class org.apache.hadoop.record.RecordComparator -->
- <class name="RecordComparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RecordComparator" type="java.lang.Class"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a raw {@link Record} comparison implementation.]]>
- </doc>
- </constructor>
- <method name="compare" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <method name="define"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="comparator" type="org.apache.hadoop.record.RecordComparator"/>
- <doc>
- <![CDATA[Register an optimized comparator for a {@link Record} implementation.
- @param c record classs for which a raw comparator is provided
- @param comparator Raw comparator instance for class c]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A raw record comparator base class]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.RecordComparator -->
- <!-- start interface org.apache.hadoop.record.RecordInput -->
- <interface name="RecordInput" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a byte from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a boolean from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read an integer from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a long integer from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a single-precision float from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a double-precision number from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a UTF-8 encoded string from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read byte array from serialized record.
- @param tag Used by tagged serialization formats (such as XML)
- @return value read from serialized record.]]>
- </doc>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized record.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized record.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized vector.
- @param tag Used by tagged serialization formats (such as XML)
- @return Index that is used to count the number of elements.]]>
- </doc>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized vector.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for start of the serialized map.
- @param tag Used by tagged serialization formats (such as XML)
- @return Index that is used to count the number of map entries.]]>
- </doc>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the mark for end of the serialized map.
- @param tag Used by tagged serialization formats (such as XML)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface that all the Deserializers have to implement.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.RecordInput -->
- <!-- start interface org.apache.hadoop.record.RecordOutput -->
- <interface name="RecordOutput" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a byte to serialized record.
- @param b Byte to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a boolean to serialized record.
- @param b Boolean to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write an integer to serialized record.
- @param i Integer to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a long integer to serialized record.
- @param l Long to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a single-precision float to serialized record.
- @param f Float to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a double precision floating point number to serialized record.
- @param d Double to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a unicode string to serialized record.
- @param s String to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a buffer to serialized record.
- @param buf Buffer to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a record to be serialized.
- @param r Record to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized record.
- @param r Record to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a vector to be serialized.
- @param v Vector to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized vector.
- @param v Vector to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="m" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the start of a map to be serialized.
- @param m Map to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="m" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Mark the end of a serialized map.
- @param m Map to be serialized
- @param tag Used by tagged serialization formats (such as XML)
- @throws IOException Indicates error in serialization]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface that alll the serializers have to implement.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.record.RecordOutput -->
- <!-- start class org.apache.hadoop.record.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a float from a byte array.]]>
- </doc>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <doc>
- <![CDATA[Parse a double from a byte array.]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
- @param bytes byte array with decode long
- @param start starting index
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
- @param bytes byte array with the encoded integer
- @param start start index
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <method name="readVLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded long from a stream and return it.
- @param in input stream
- @throws java.io.IOException
- @return deserialized long]]>
- </doc>
- </method>
- <method name="readVInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads a zero-compressed encoded integer from a stream and returns it.
- @param in input stream
- @throws java.io.IOException
- @return deserialized integer]]>
- </doc>
- </method>
- <method name="getVIntSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="long"/>
- <doc>
- <![CDATA[Get the encoded length if an integer is stored in a variable-length format
- @return the encoded length]]>
- </doc>
- </method>
- <method name="writeVLong"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
- For -112 <= i <= 127, only one byte is used with the actual value.
- For other values of i, the first byte value indicates whether the
- long is positive or negative, and the number of bytes that follow.
- If the first byte value v is between -113 and -120, the following long
- is positive, with number of bytes that follow are -(v+112).
- If the first byte value v is between -121 and -128, the following long
- is negative, with number of bytes that follow are -(v+120). Bytes are
- stored in the high-non-zero-byte-first order.
- @param stream Binary output stream
- @param i Long to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="writeVInt"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.DataOutput"/>
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serializes an int to a binary stream with zero-compressed encoding.
- @param stream Binary output stream
- @param i int to be serialized
- @throws java.io.IOException]]>
- </doc>
- </method>
- <method name="compareBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- <doc>
- <![CDATA[Lexicographic order of binary data.]]>
- </doc>
- </method>
- <field name="hexchars" type="char[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Various utility functions for Hadooop record I/O runtime.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.Utils -->
- <!-- start class org.apache.hadoop.record.XmlRecordInput -->
- <class name="XmlRecordInput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordInput"/>
- <constructor name="XmlRecordInput" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of XmlRecordInput]]>
- </doc>
- </constructor>
- <method name="readByte" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBool" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFloat" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readDouble" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readBuffer" return="org.apache.hadoop.record.Buffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap" return="org.apache.hadoop.record.Index"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[XML Deserializer.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.XmlRecordInput -->
- <!-- start class org.apache.hadoop.record.XmlRecordOutput -->
- <class name="XmlRecordOutput" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.RecordOutput"/>
- <constructor name="XmlRecordOutput" type="java.io.OutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of XmlRecordOutput]]>
- </doc>
- </constructor>
- <method name="writeByte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="boolean"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeInt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeLong"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="l" type="long"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeFloat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="f" type="float"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeDouble"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="org.apache.hadoop.record.Buffer"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.record.Record"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.ArrayList"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="startMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="endMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="v" type="java.util.TreeMap"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[XML Serializer.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.XmlRecordOutput -->
- </package>
- <package name="org.apache.hadoop.record.compiler">
- <!-- start class org.apache.hadoop.record.compiler.CodeBuffer -->
- <class name="CodeBuffer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A wrapper around StringBuffer that automatically does indentation]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.CodeBuffer -->
- <!-- start class org.apache.hadoop.record.compiler.Consts -->
- <class name="Consts" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="RIO_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_VAR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RTI_FILTER_FIELDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_OUTPUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_INPUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TAG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[const definitions for Record I/O compiler]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.Consts -->
- <!-- start class org.apache.hadoop.record.compiler.JBoolean -->
- <class name="JBoolean" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JBoolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JBoolean]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JBoolean -->
- <!-- start class org.apache.hadoop.record.compiler.JBuffer -->
- <class name="JBuffer" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JBuffer]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "buffer" type.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JBuffer -->
- <!-- start class org.apache.hadoop.record.compiler.JByte -->
- <class name="JByte" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JByte"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Code generator for "byte" type.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JByte -->
- <!-- start class org.apache.hadoop.record.compiler.JDouble -->
- <class name="JDouble" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JDouble"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JDouble]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JDouble -->
- <!-- start class org.apache.hadoop.record.compiler.JField -->
- <class name="JField" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JField" type="java.lang.String, java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JField]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[A thin wrappper around record field.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JField -->
- <!-- start class org.apache.hadoop.record.compiler.JFile -->
- <class name="JFile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JFile" type="java.lang.String, java.util.ArrayList, java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JFile
- @param name possibly full pathname to the file
- @param inclFiles included files (as JFile)
- @param recList List of records defined within this file]]>
- </doc>
- </constructor>
- <method name="genCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="language" type="java.lang.String"/>
- <param name="destDir" type="java.lang.String"/>
- <param name="options" type="java.util.ArrayList"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Generate record code in given language. Language should be all
- lowercase.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Container for the Hadoop Record DDL.
- The main components of the file are filename, list of included files,
- and records defined in that file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JFile -->
- <!-- start class org.apache.hadoop.record.compiler.JFloat -->
- <class name="JFloat" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JFloat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JFloat]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JFloat -->
- <!-- start class org.apache.hadoop.record.compiler.JInt -->
- <class name="JInt" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JInt"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JInt]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "int" type]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JInt -->
- <!-- start class org.apache.hadoop.record.compiler.JLong -->
- <class name="JLong" extends="org.apache.hadoop.record.compiler.JType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JLong"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JLong]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Code generator for "long" type]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JLong -->
- <!-- start class org.apache.hadoop.record.compiler.JMap -->
- <class name="JMap" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JMap" type="org.apache.hadoop.record.compiler.JType, org.apache.hadoop.record.compiler.JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JMap]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JMap -->
- <!-- start class org.apache.hadoop.record.compiler.JRecord -->
- <class name="JRecord" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JRecord" type="java.lang.String, java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JRecord]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JRecord -->
- <!-- start class org.apache.hadoop.record.compiler.JString -->
- <class name="JString" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JString"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JString]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JString -->
- <!-- start class org.apache.hadoop.record.compiler.JType -->
- <class name="JType" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Abstract Base class for all types supported by Hadoop Record I/O.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JType -->
- <!-- start class org.apache.hadoop.record.compiler.JVector -->
- <class name="JVector" extends="org.apache.hadoop.record.compiler.JCompType"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JVector" type="org.apache.hadoop.record.compiler.JType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of JVector]]>
- </doc>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.JVector -->
- </package>
- <package name="org.apache.hadoop.record.compiler.ant">
- <!-- start class org.apache.hadoop.record.compiler.ant.RccTask -->
- <class name="RccTask" extends="org.apache.tools.ant.Task"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RccTask"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new instance of RccTask]]>
- </doc>
- </constructor>
- <method name="setLanguage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="language" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the output language option
- @param language "java"/"c++"]]>
- </doc>
- </method>
- <method name="setFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.io.File"/>
- <doc>
- <![CDATA[Sets the record definition file attribute
- @param file record definition file]]>
- </doc>
- </method>
- <method name="setFailonerror"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="boolean"/>
- <doc>
- <![CDATA[Given multiple files (via fileset), set the error handling behavior
- @param flag true will throw build exception in case of failure (default)]]>
- </doc>
- </method>
- <method name="setDestdir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[Sets directory where output files will be generated
- @param dir output directory]]>
- </doc>
- </method>
- <method name="addFileset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="set" type="org.apache.tools.ant.types.FileSet"/>
- <doc>
- <![CDATA[Adds a fileset that can consist of one or more files
- @param set Set of record definition files]]>
- </doc>
- </method>
- <method name="execute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="BuildException" type="org.apache.tools.ant.BuildException"/>
- <doc>
- <![CDATA[Invoke the Hadoop record compiler on each record definition file]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Hadoop record compiler ant Task
- <p> This task takes the given record definition files and compiles them into
- java or c++
- files. It is then up to the user to compile the generated files.
- <p> The task requires the <code>file</code> or the nested fileset element to be
- specified. Optional attributes are <code>language</code> (set the output
- language, default is "java"),
- <code>destdir</code> (name of the destination directory for generated java/c++
- code, default is ".") and <code>failonerror</code> (specifies error handling
- behavior. default is true).
- <p><h4>Usage</h4>
- <pre>
- <recordcc
- destdir="${basedir}/gensrc"
- language="java">
- <fileset include="**\/*.jr" />
- </recordcc>
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.ant.RccTask -->
- </package>
- <package name="org.apache.hadoop.record.compiler.generated">
- <!-- start class org.apache.hadoop.record.compiler.generated.ParseException -->
- <class name="ParseException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ParseException" type="org.apache.hadoop.record.compiler.generated.Token, int[][], java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor is used by the method "generateParseException"
- in the generated parser. Calling this constructor generates
- a new object of this type with the fields "currentToken",
- "expectedTokenSequences", and "tokenImage" set. The boolean
- flag "specialConstructor" is also set to true to indicate that
- this constructor was used to create this object.
- This constructor calls its super class with the empty string
- to force the "toString" method of parent class "Throwable" to
- print the error message in the form:
- ParseException: <result of getMessage>]]>
- </doc>
- </constructor>
- <constructor name="ParseException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The following constructors are for use by you for whatever
- purpose you can think of. Constructing the exception in this
- manner makes the exception behave in the normal way - i.e., as
- documented in the class "Throwable". The fields "errorToken",
- "expectedTokenSequences", and "tokenImage" do not contain
- relevant information. The JavaCC generated code does not use
- these constructors.]]>
- </doc>
- </constructor>
- <constructor name="ParseException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method has the standard behavior when this object has been
- created using the standard constructors. Otherwise, it uses
- "currentToken" and "expectedTokenSequences" to generate a parse
- error message and returns it. If this object has been created
- due to a parse error, and you do not catch it (it gets thrown
- from the parser), then this method is called during the printing
- of the final stack trace, and hence the correct error message
- gets displayed.]]>
- </doc>
- </method>
- <method name="add_escapes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Used to convert raw characters to their escaped version
- when these raw version cannot be used as part of an ASCII
- string literal.]]>
- </doc>
- </method>
- <field name="specialConstructor" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This variable determines which constructor was used to create
- this object and thereby affects the semantics of the
- "getMessage" method (see below).]]>
- </doc>
- </field>
- <field name="currentToken" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This is the last token that has been consumed successfully. If
- this object has been created due to a parse error, the token
- followng this token will (therefore) be the first error token.]]>
- </doc>
- </field>
- <field name="expectedTokenSequences" type="int[][]"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Each entry in this array is an array of integers. Each array
- of integers represents a sequence of tokens (by their ordinal
- values) that is expected at this point of the parse.]]>
- </doc>
- </field>
- <field name="tokenImage" type="java.lang.String[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This is a reference to the "tokenImage" array of the generated
- parser within which the parse error occurred. This array is
- defined in the generated ...Constants interface.]]>
- </doc>
- </field>
- <field name="eol" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The end of line string for this machine.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This exception is thrown when parse errors are encountered.
- You can explicitly create objects of this exception type by
- calling the method generateParseException in the generated
- parser.
- You can modify this class to customize your error reporting
- mechanisms so long as you retain the public fields.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.ParseException -->
- <!-- start class org.apache.hadoop.record.compiler.generated.Rcc -->
- <class name="Rcc" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
- <constructor name="Rcc" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="java.io.InputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="java.io.Reader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Rcc" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <method name="usage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="driver" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <method name="Input" return="org.apache.hadoop.record.compiler.JFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Include" return="org.apache.hadoop.record.compiler.JFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Module" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="ModuleName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="RecordList" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Record" return="org.apache.hadoop.record.compiler.JRecord"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Field" return="org.apache.hadoop.record.compiler.JField"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Type" return="org.apache.hadoop.record.compiler.JType"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Map" return="org.apache.hadoop.record.compiler.JMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="Vector" return="org.apache.hadoop.record.compiler.JVector"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.InputStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.Reader"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tm" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"/>
- </method>
- <method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="index" type="int"/>
- </method>
- <method name="generateParseException" return="org.apache.hadoop.record.compiler.generated.ParseException"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="enable_tracing"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="disable_tracing"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="token_source" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="token" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jj_nt" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.Rcc -->
- <!-- start interface org.apache.hadoop.record.compiler.generated.RccConstants -->
- <interface name="RccConstants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="EOF" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MODULE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECORD_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INCLUDE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BOOLEAN_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOAT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOUBLE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USTRING_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BUFFER_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VECTOR_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LBRACE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RBRACE_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="GT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SEMICOLON_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMA_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CSTRING_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IDENT_TKN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WithinOneLineComment" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WithinMultiLineComment" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="tokenImage" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </interface>
- <!-- end interface org.apache.hadoop.record.compiler.generated.RccConstants -->
- <!-- start class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
- <class name="RccTokenManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
- <constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setDebugStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ds" type="java.io.PrintStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
- <param name="lexState" type="int"/>
- </method>
- <method name="SwitchTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lexState" type="int"/>
- </method>
- <method name="jjFillToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="debugStream" type="java.io.PrintStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jjstrLiteralImages" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="lexStateNames" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jjnewLexState" type="int[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="input_stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="curChar" type="char"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
- <!-- start class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
- <class name="SimpleCharStream" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SimpleCharStream" type="java.io.Reader, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.Reader, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.Reader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </constructor>
- <constructor name="SimpleCharStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setTabSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- </method>
- <method name="getTabSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- </method>
- <method name="ExpandBuff"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="wrapAround" type="boolean"/>
- </method>
- <method name="FillBuff"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="BeginToken" return="char"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="UpdateLineColumn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="c" type="char"/>
- </method>
- <method name="readChar" return="char"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getEndColumn" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getEndLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBeginColumn" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBeginLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="backup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="amount" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.Reader"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <param name="buffersize" type="int"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="encoding" type="java.lang.String"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- <exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
- </method>
- <method name="ReInit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dstream" type="java.io.InputStream"/>
- <param name="startline" type="int"/>
- <param name="startcolumn" type="int"/>
- </method>
- <method name="GetImage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="GetSuffix" return="char[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="len" type="int"/>
- </method>
- <method name="Done"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="adjustBeginLineColumn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newLine" type="int"/>
- <param name="newCol" type="int"/>
- <doc>
- <![CDATA[Method to adjust line and column numbers for the start of a token.]]>
- </doc>
- </method>
- <field name="staticFlag" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="bufpos" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="bufline" type="int[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="bufcolumn" type="int[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="column" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="line" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="prevCharIsCR" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="prevCharIsLF" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="inputStream" type="java.io.Reader"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="buffer" type="char[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="maxNextCharInd" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="inBuf" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="tabSize" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An implementation of interface CharStream, where the stream is assumed to
- contain only ASCII characters (without unicode processing).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
- <!-- start class org.apache.hadoop.record.compiler.generated.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the image.]]>
- </doc>
- </method>
- <method name="newToken" return="org.apache.hadoop.record.compiler.generated.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="ofKind" type="int"/>
- <doc>
- <![CDATA[Returns a new Token object, by default. However, if you want, you
- can create and return subclass objects based on the value of ofKind.
- Simply add the cases to the switch for all those special cases.
- For example, if you have a subclass of Token called IDToken that
- you want to create if ofKind is ID, simlpy add something like :
- case MyParserConstants.ID : return new IDToken();
- to the following switch statement. Then you can cast matchedToken
- variable to the appropriate type and use it in your lexical actions.]]>
- </doc>
- </method>
- <field name="kind" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[An integer that describes the kind of this token. This numbering
- system is determined by JavaCCParser, and a table of these numbers is
- stored in the file ...Constants.java.]]>
- </doc>
- </field>
- <field name="beginLine" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="beginColumn" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="endLine" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="endColumn" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[beginLine and beginColumn describe the position of the first character
- of this token; endLine and endColumn describe the position of the
- last character of this token.]]>
- </doc>
- </field>
- <field name="image" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The string image of the token.]]>
- </doc>
- </field>
- <field name="next" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A reference to the next regular (non-special) token from the input
- stream. If this is the last token from the input stream, or if the
- token manager has not read tokens beyond this one, this field is
- set to null. This is true only if this token is also a regular
- token. Otherwise, see below for a description of the contents of
- this field.]]>
- </doc>
- </field>
- <field name="specialToken" type="org.apache.hadoop.record.compiler.generated.Token"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This field is used to access special tokens that occur prior to this
- token, but after the immediately preceding regular (non-special) token.
- If there are no such special tokens, this field is set to null.
- When there are more than one such special token, this field refers
- to the last of these special tokens, which in turn refers to the next
- previous special token through its specialToken field, and so on
- until the first special token (whose specialToken field is null).
- The next fields of special tokens refer to other special tokens that
- immediately follow it (without an intervening regular token). If there
- is no such token, this field is null.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Describes the input token stream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.Token -->
- <!-- start class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
- <class name="TokenMgrError" extends="java.lang.Error"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TokenMgrError"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TokenMgrError" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TokenMgrError" type="boolean, int, int, int, java.lang.String, char, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addEscapes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Replaces unprintable characters by their espaced (or unicode escaped)
- equivalents in the given string]]>
- </doc>
- </method>
- <method name="LexicalError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="EOFSeen" type="boolean"/>
- <param name="lexState" type="int"/>
- <param name="errorLine" type="int"/>
- <param name="errorColumn" type="int"/>
- <param name="errorAfter" type="java.lang.String"/>
- <param name="curChar" type="char"/>
- <doc>
- <![CDATA[Returns a detailed message for the Error when it is thrown by the
- token manager to indicate a lexical error.
- Parameters :
- EOFSeen : indicates if EOF caused the lexicl error
- curLexState : lexical state in which this error occured
- errorLine : line number when the error occured
- errorColumn : column number when the error occured
- errorAfter : prefix that was seen before this error occured
- curchar : the offending character
- Note: You can customize the lexical error message by modifying this method.]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[You can also modify the body of this method to customize your error messages.
- For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
- of end-users concern, so you can return something like :
- "Internal Error : Please file a bug report .... "
- from this method for such cases in the release version of your parser.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
- </package>
- <package name="org.apache.hadoop.record.meta">
- <!-- start class org.apache.hadoop.record.meta.FieldTypeInfo -->
- <class name="FieldTypeInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the field's TypeID object]]>
- </doc>
- </method>
- <method name="getFieldID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the field's id (name)]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two FieldTypeInfos are equal if ach of their fields matches]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ti" type="org.apache.hadoop.record.meta.FieldTypeInfo"/>
- </method>
- <doc>
- <![CDATA[Represents a type information for a field, which is made up of its
- ID (name) and its type (a TypeID object).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.FieldTypeInfo -->
- <!-- start class org.apache.hadoop.record.meta.MapTypeID -->
- <class name="MapTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapTypeID" type="org.apache.hadoop.record.meta.TypeID, org.apache.hadoop.record.meta.TypeID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKeyTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the TypeID of the map's key element]]>
- </doc>
- </method>
- <method name="getValueTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the TypeID of the map's value element]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two map typeIDs are equal if their constituent elements have the
- same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents typeID for a Map]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.MapTypeID -->
- <!-- start class org.apache.hadoop.record.meta.RecordTypeInfo -->
- <class name="RecordTypeInfo" extends="org.apache.hadoop.record.Record"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RecordTypeInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty RecordTypeInfo object.]]>
- </doc>
- </constructor>
- <constructor name="RecordTypeInfo" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a RecordTypeInfo object representing a record with the given name
- @param name Name of the record]]>
- </doc>
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return the name of the record]]>
- </doc>
- </method>
- <method name="setName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[set the name of the record]]>
- </doc>
- </method>
- <method name="addField"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldName" type="java.lang.String"/>
- <param name="tid" type="org.apache.hadoop.record.meta.TypeID"/>
- <doc>
- <![CDATA[Add a field.
- @param fieldName Name of the field
- @param tid Type ID of the field]]>
- </doc>
- </method>
- <method name="getFieldTypeInfos" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a collection of field type infos]]>
- </doc>
- </method>
- <method name="getNestedStructTypeInfo" return="org.apache.hadoop.record.meta.RecordTypeInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Return the type info of a nested record. We only consider nesting
- to one level.
- @param name Name of the nested record]]>
- </doc>
- </method>
- <method name="serialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Serialize the type information for a record]]>
- </doc>
- </method>
- <method name="deserialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Deserialize the type information for a record]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="peer_" type="java.lang.Object"/>
- <exception name="ClassCastException" type="java.lang.ClassCastException"/>
- <doc>
- <![CDATA[This class doesn't implement Comparable as it's not meant to be used
- for anything besides de/serializing.
- So we always throw an exception.
- Not implemented. Always returns 0 if another RecordTypeInfo is passed in.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A record's Type Information object which can read/write itself.
-
- Type information for a record comprises metadata about the record,
- as well as a collection of type information for each field in the record.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.RecordTypeInfo -->
- <!-- start class org.apache.hadoop.record.meta.StructTypeID -->
- <class name="StructTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StructTypeID" type="org.apache.hadoop.record.meta.RecordTypeInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a StructTypeID based on the RecordTypeInfo of some record]]>
- </doc>
- </constructor>
- <method name="getFieldTypeInfos" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Represents typeID for a struct]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.StructTypeID -->
- <!-- start class org.apache.hadoop.record.meta.TypeID -->
- <class name="TypeID" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getTypeVal" return="byte"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the type value. One of the constants in RIOType.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two base typeIDs are equal if they refer to the same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <field name="BoolTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant classes for the basic types, so we can share them.]]>
- </doc>
- </field>
- <field name="BufferTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ByteTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DoubleTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FloatTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IntTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LongTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="StringTypeID" type="org.apache.hadoop.record.meta.TypeID"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="typeVal" type="byte"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Represents typeID for basic types.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.TypeID -->
- <!-- start class org.apache.hadoop.record.meta.TypeID.RIOType -->
- <class name="TypeID.RIOType" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="TypeID.RIOType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="BOOL" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BUFFER" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTE" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOUBLE" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOAT" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INT" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STRING" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STRUCT" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VECTOR" type="byte"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[constants representing the IDL types we support]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.TypeID.RIOType -->
- <!-- start class org.apache.hadoop.record.meta.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rin" type="org.apache.hadoop.record.RecordInput"/>
- <param name="tag" type="java.lang.String"/>
- <param name="typeID" type="org.apache.hadoop.record.meta.TypeID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[read/skip bytes from stream based on a type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Various utility functions for Hadooop record I/O platform.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.Utils -->
- <!-- start class org.apache.hadoop.record.meta.VectorTypeID -->
- <class name="VectorTypeID" extends="org.apache.hadoop.record.meta.TypeID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VectorTypeID" type="org.apache.hadoop.record.meta.TypeID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getElementTypeID" return="org.apache.hadoop.record.meta.TypeID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Two vector typeIDs are equal if their constituent elements have the
- same type]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[We use a basic hashcode implementation, since this class will likely not
- be used as a hashmap key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents typeID for vector.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.record.meta.VectorTypeID -->
- </package>
- <package name="org.apache.hadoop.security">
- <!-- start class org.apache.hadoop.security.AccessControlException -->
- <class name="AccessControlException" extends="org.apache.hadoop.fs.permission.AccessControlException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AccessControlException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor is needed for unwrapping from
- {@link org.apache.hadoop.ipc.RemoteException}.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs an {@link AccessControlException}
- with the specified detail message.
- @param s the detail message.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[An exception class for access control related issues.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.AccessControlException -->
- <!-- start class org.apache.hadoop.security.AuthenticationFilterInitializer -->
- <class name="AuthenticationFilterInitializer" extends="org.apache.hadoop.http.FilterInitializer"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthenticationFilterInitializer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="container" type="org.apache.hadoop.http.FilterContainer"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Initializes Alfredo AuthenticationFilter.
- <p/>
- Propagates to Alfredo AuthenticationFilter configuration all Hadoop
- configuration properties prefixed with "hadoop.http.authentication."
- @param container The filter container
- @param conf Configuration for run-time parameters]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initializes Alfredo AuthenticationFilter which provides support for
- Kerberos HTTP SPNEGO authentication.
- <p/>
- It enables anonymous access, simple/speudo and Kerberos HTTP SPNEGO
- authentication for Hadoop JobTracker, NameNode, DataNodes and
- TaskTrackers.
- <p/>
- Refer to the <code>core-default.xml</code> file, after the comment
- 'HTTP Authentication' for details on the configuration options.
- All related configuration properties have 'hadoop.http.authentication.'
- as prefix.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.AuthenticationFilterInitializer -->
- <!-- start class org.apache.hadoop.security.Credentials -->
- <class name="Credentials" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSecretKey" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Returns the key bytes for the alias
- @param alias the alias for the key
- @return key for this alias]]>
- </doc>
- </method>
- <method name="getToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Returns the Token object for the alias
- @param alias the alias for the Token
- @return token for this alias]]>
- </doc>
- </method>
- <method name="addToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <param name="t" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add a token in the storage (in memory)
- @param alias the alias for the key
- @param t the token object]]>
- </doc>
- </method>
- <method name="getAllTokens" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all the tokens in the in-memory map]]>
- </doc>
- </method>
- <method name="numberOfTokens" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of Tokens in the in-memory map]]>
- </doc>
- </method>
- <method name="numberOfSecretKeys" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of keys in the in-memory map]]>
- </doc>
- </method>
- <method name="addSecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Set the key for an alias
- @param alias the alias for the key
- @param key the key bytes]]>
- </doc>
- </method>
- <method name="readTokenStorageFile" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method for reading a token storage file, and loading the Tokens
- therein in the passed UGI
- @param filename
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="readTokenStorageStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method for reading a token storage file directly from a
- datainputstream]]>
- </doc>
- </method>
- <method name="writeTokenStorageToStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="os" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeTokenStorageFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Stores all the keys to DataOutput
- @param out
- @throws IOException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Loads all the keys
- @param in
- @throws IOException]]>
- </doc>
- </method>
- <method name="addAll"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[Copy all of the credentials from one credential object into another.
- @param other the credentials to copy]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that provides the facilities of reading and writing
- secret keys and Tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.Credentials -->
- <!-- start class org.apache.hadoop.security.Groups -->
- <class name="Groups" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Groups" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the group memberships of a given user.
- @param user User's name
- @return the group memberships of the user
- @throws IOException]]>
- </doc>
- </method>
- <method name="refresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Refresh all user-to-groups mappings.]]>
- </doc>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- </method>
- <method name="getUserToGroupsMappingService" return="org.apache.hadoop.security.Groups"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the groups being used to map user-to-groups.
- @return the groups being used to map user-to-groups.]]>
- </doc>
- </method>
- <method name="getUserToGroupsMappingService" return="org.apache.hadoop.security.Groups"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <doc>
- <![CDATA[A user-to-groups mapping service.
-
- {@link Groups} allows for server to get the various group memberships
- of a given user via the {@link #getGroups(String)} call, thus ensuring
- a consistent user-to-groups mapping and protects against vagaries of
- different mappings on servers and clients in a Hadoop cluster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.Groups -->
- <!-- start class org.apache.hadoop.security.JniBasedUnixGroupsMapping -->
- <class name="JniBasedUnixGroupsMapping" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.GroupMappingServiceProvider"/>
- <constructor name="JniBasedUnixGroupsMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A JNI-based implementation of {@link GroupMappingServiceProvider}
- that invokes libC calls to get the group
- memberships of a given user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.JniBasedUnixGroupsMapping -->
- <!-- start class org.apache.hadoop.security.JniBasedUnixGroupsMappingWithFallback -->
- <class name="JniBasedUnixGroupsMappingWithFallback" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.GroupMappingServiceProvider"/>
- <constructor name="JniBasedUnixGroupsMappingWithFallback"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.security.JniBasedUnixGroupsMappingWithFallback -->
- <!-- start class org.apache.hadoop.security.JniBasedUnixGroupsNetgroupMapping -->
- <class name="JniBasedUnixGroupsNetgroupMapping" extends="org.apache.hadoop.security.JniBasedUnixGroupsMapping"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JniBasedUnixGroupsNetgroupMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets unix groups and netgroups for the user.
- It gets all unix groups as returned by id -Gn but it
- only returns netgroups that are used in ACLs (there is
- no way to get all netgroups for a given user, see
- documentation for getent netgroup)]]>
- </doc>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getUsersForNetgroup" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="netgroup" type="java.lang.String"/>
- <doc>
- <![CDATA[Calls JNI function to get users for a netgroup, since C functions
- are not reentrant we need to make this synchronized (see
- documentation for setnetgrent, getnetgrent and endnetgrent)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A JNI-based implementation of {@link GroupMappingServiceProvider}
- that invokes libC calls to get the group
- memberships of a given user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.JniBasedUnixGroupsNetgroupMapping -->
- <!-- start class org.apache.hadoop.security.JniBasedUnixGroupsNetgroupMappingWithFallback -->
- <class name="JniBasedUnixGroupsNetgroupMappingWithFallback" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.GroupMappingServiceProvider"/>
- <constructor name="JniBasedUnixGroupsNetgroupMappingWithFallback"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.security.JniBasedUnixGroupsNetgroupMappingWithFallback -->
- <!-- start interface org.apache.hadoop.security.KerberosInfo -->
- <interface name="KerberosInfo" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <method name="serverPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Key for getting server's Kerberos principal name from Configuration]]>
- </doc>
- </method>
- <method name="clientPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Indicates Kerberos related information to be used]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.KerberosInfo -->
- <!-- start class org.apache.hadoop.security.KerberosName -->
- <class name="KerberosName" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KerberosName" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a name from the full Kerberos principal name.
- @param name]]>
- </doc>
- </constructor>
- <method name="getDefaultRealm" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configured default realm.
- @return the default realm from the krb5.conf]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Put the name back together from the parts.]]>
- </doc>
- </method>
- <method name="getServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the first component of the name.
- @return the first section of the Kerberos principal name]]>
- </doc>
- </method>
- <method name="getHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the second component of the name.
- @return the second section of the Kerberos principal name, and may be null]]>
- </doc>
- </method>
- <method name="getRealm" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the realm of the name.
- @return the realm of the name, may be null]]>
- </doc>
- </method>
- <method name="setConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the static configuration to get the rules.
- @param conf the new configuration
- @throws IOException]]>
- </doc>
- </method>
- <method name="setRules"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ruleString" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the rules.
- @param ruleString the rules string.]]>
- </doc>
- </method>
- <method name="getShortName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the translation of the principal name into an operating system
- user name.
- @return the short name
- @throws IOException]]>
- </doc>
- </method>
- <method name="printRules"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[This class implements parsing and handling of Kerberos principal names. In
- particular, it splits them apart and translates them down into local
- operating system names.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.KerberosName -->
- <!-- start class org.apache.hadoop.security.KerberosName.BadFormatString -->
- <class name="KerberosName.BadFormatString" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.security.KerberosName.BadFormatString -->
- <!-- start class org.apache.hadoop.security.KerberosName.NoMatchingRule -->
- <class name="KerberosName.NoMatchingRule" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.security.KerberosName.NoMatchingRule -->
- <!-- start class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector -->
- <class name="Krb5AndCertsSslSocketConnector" extends="org.mortbay.jetty.security.SslSocketConnector"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Krb5AndCertsSslSocketConnector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Krb5AndCertsSslSocketConnector" type="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createFactory" return="javax.net.ssl.SSLServerSocketFactory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="newServerSocket" return="java.net.ServerSocket"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="backlog" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="customize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="endpoint" type="org.mortbay.io.EndPoint"/>
- <param name="request" type="org.mortbay.jetty.Request"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="KRB5_CIPHER_SUITES" type="java.util.List"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Extend Jetty's {@link SslSocketConnector} to optionally also provide
- Kerberos5ized SSL sockets. The only change in behavior from superclass
- is that we no longer honor requests to turn off NeedAuthentication when
- running with Kerberos support.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector -->
- <!-- start class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.Krb5SslFilter -->
- <class name="Krb5AndCertsSslSocketConnector.Krb5SslFilter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="Krb5AndCertsSslSocketConnector.Krb5SslFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="req" type="javax.servlet.ServletRequest"/>
- <param name="resp" type="javax.servlet.ServletResponse"/>
- <param name="chain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Filter that takes the Kerberos principal identified in the
- {@link Krb5AndCertsSslSocketConnector} and provides it the to the servlet
- at runtime, setting the principal and short name.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.Krb5SslFilter -->
- <!-- start class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE -->
- <class name="Krb5AndCertsSslSocketConnector.MODE" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="KRB" type="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CERTS" type="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BOTH" type="org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.Krb5AndCertsSslSocketConnector.MODE -->
- <!-- start class org.apache.hadoop.security.NetgroupCache -->
- <class name="NetgroupCache" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NetgroupCache"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNetgroups"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="groups" type="java.util.List"/>
- </method>
- <method name="getNetgroupNames" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isCached" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="users" type="java.util.List"/>
- </method>
- <doc>
- <![CDATA[Class that caches the netgroups and inverts group-to-user map
- to user-to-group map]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.NetgroupCache -->
- <!-- start interface org.apache.hadoop.security.RefreshUserMappingsProtocol -->
- <interface name="RefreshUserMappingsProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- <method name="refreshUserToGroupsMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh user to group mappings.
- @throws IOException]]>
- </doc>
- </method>
- <method name="refreshSuperUserGroupsConfiguration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh superuser proxy group list
- @throws IOException]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Version 1: Initial version.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Protocol use]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.RefreshUserMappingsProtocol -->
- <!-- start class org.apache.hadoop.security.SaslInputStream -->
- <class name="SaslInputStream" extends="java.io.InputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SaslInputStream" type="java.io.InputStream, javax.security.sasl.SaslServer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a SASLInputStream from an InputStream and a SaslServer <br>
- Note: if the specified InputStream or SaslServer is null, a
- NullPointerException may be thrown later when they are used.
-
- @param inStream
- the InputStream to be processed
- @param saslServer
- an initialized SaslServer object]]>
- </doc>
- </constructor>
- <constructor name="SaslInputStream" type="java.io.InputStream, javax.security.sasl.SaslClient"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a SASLInputStream from an InputStream and a SaslClient <br>
- Note: if the specified InputStream or SaslClient is null, a
- NullPointerException may be thrown later when they are used.
-
- @param inStream
- the InputStream to be processed
- @param saslClient
- an initialized SaslClient object]]>
- </doc>
- </constructor>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads the next byte of data from this input stream. The value byte is
- returned as an <code>int</code> in the range <code>0</code> to
- <code>255</code>. If no byte is available because the end of the stream has
- been reached, the value <code>-1</code> is returned. This method blocks
- until input data is available, the end of the stream is detected, or an
- exception is thrown.
- <p>
-
- @return the next byte of data, or <code>-1</code> if the end of the stream
- is reached.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads up to <code>b.length</code> bytes of data from this input stream into
- an array of bytes.
- <p>
- The <code>read</code> method of <code>InputStream</code> calls the
- <code>read</code> method of three arguments with the arguments
- <code>b</code>, <code>0</code>, and <code>b.length</code>.
-
- @param b
- the buffer into which the data is read.
- @return the total number of bytes read into the buffer, or <code>-1</code>
- is there is no more data because the end of the stream has been
- reached.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads up to <code>len</code> bytes of data from this input stream into an
- array of bytes. This method blocks until some input is available. If the
- first argument is <code>null,</code> up to <code>len</code> bytes are read
- and discarded.
-
- @param b
- the buffer into which the data is read.
- @param off
- the start offset of the data.
- @param len
- the maximum number of bytes read.
- @return the total number of bytes read into the buffer, or <code>-1</code>
- if there is no more data because the end of the stream has been
- reached.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="skip" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skips <code>n</code> bytes of input from the bytes that can be read from
- this input stream without blocking.
-
- <p>
- Fewer bytes than requested might be skipped. The actual number of bytes
- skipped is equal to <code>n</code> or the result of a call to
- {@link #available() <code>available</code>}, whichever is smaller. If
- <code>n</code> is less than zero, no bytes are skipped.
-
- <p>
- The actual number of bytes skipped is returned.
-
- @param n
- the number of bytes to be skipped.
- @return the actual number of bytes skipped.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="available" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the number of bytes that can be read from this input stream without
- blocking. The <code>available</code> method of <code>InputStream</code>
- returns <code>0</code>. This method <B>should</B> be overridden by
- subclasses.
-
- @return the number of bytes that can be read from this input stream without
- blocking.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes this input stream and releases any system resources associated with
- the stream.
- <p>
- The <code>close</code> method of <code>SASLInputStream</code> calls the
- <code>close</code> method of its underlying input stream.
-
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="markSupported" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Tests if this input stream supports the <code>mark</code> and
- <code>reset</code> methods, which it does not.
-
- @return <code>false</code>, since this class does not support the
- <code>mark</code> and <code>reset</code> methods.]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A SaslInputStream is composed of an InputStream and a SaslServer (or
- SaslClient) so that read() methods return data that are read in from the
- underlying InputStream but have been additionally processed by the SaslServer
- (or SaslClient) object. The SaslServer (or SaslClient) object must be fully
- initialized before being used by a SaslInputStream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslInputStream -->
- <!-- start class org.apache.hadoop.security.SaslOutputStream -->
- <class name="SaslOutputStream" extends="java.io.OutputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SaslOutputStream" type="java.io.OutputStream, javax.security.sasl.SaslServer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a SASLOutputStream from an OutputStream and a SaslServer <br>
- Note: if the specified OutputStream or SaslServer is null, a
- NullPointerException may be thrown later when they are used.
-
- @param outStream
- the OutputStream to be processed
- @param saslServer
- an initialized SaslServer object]]>
- </doc>
- </constructor>
- <constructor name="SaslOutputStream" type="java.io.OutputStream, javax.security.sasl.SaslClient"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a SASLOutputStream from an OutputStream and a SaslClient <br>
- Note: if the specified OutputStream or SaslClient is null, a
- NullPointerException may be thrown later when they are used.
-
- @param outStream
- the OutputStream to be processed
- @param saslClient
- an initialized SaslClient object]]>
- </doc>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes the specified byte to this output stream.
-
- @param b
- the <code>byte</code>.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes <code>b.length</code> bytes from the specified byte array to this
- output stream.
- <p>
- The <code>write</code> method of <code>SASLOutputStream</code> calls the
- <code>write</code> method of three arguments with the three arguments
- <code>b</code>, <code>0</code>, and <code>b.length</code>.
-
- @param b
- the data.
- @exception NullPointerException
- if <code>b</code> is null.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inBuf" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes <code>len</code> bytes from the specified byte array starting at
- offset <code>off</code> to this output stream.
-
- @param inBuf
- the data.
- @param off
- the start offset in the data.
- @param len
- the number of bytes to write.
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Flushes this output stream
-
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes this output stream and releases any system resources associated with
- this stream.
-
- @exception IOException
- if an I/O error occurs.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A SaslOutputStream is composed of an OutputStream and a SaslServer (or
- SaslClient) so that write() methods first process the data before writing
- them out to the underlying OutputStream. The SaslServer (or SaslClient)
- object must be fully initialized before being used by a SaslOutputStream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslOutputStream -->
- <!-- start class org.apache.hadoop.security.SaslRpcClient -->
- <class name="SaslRpcClient" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SaslRpcClient" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod, org.apache.hadoop.security.token.Token, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a SaslRpcClient for an authentication method
-
- @param method
- the requested authentication method
- @param token
- token to use if needed by the authentication method]]>
- </doc>
- </constructor>
- <method name="saslConnect" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inS" type="java.io.InputStream"/>
- <param name="outS" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Do client side SASL authentication with server via the given InputStream
- and OutputStream
-
- @param inS
- InputStream to use
- @param outS
- OutputStream to use
- @return true if connection is set up, or false if needs to switch
- to simple Auth.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getInputStream" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a SASL wrapped InputStream. Can be called only after saslConnect() has
- been called.
-
- @param in
- the InputStream to wrap
- @return a SASL wrapped InputStream
- @throws IOException]]>
- </doc>
- </method>
- <method name="getOutputStream" return="java.io.OutputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.OutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a SASL wrapped OutputStream. Can be called only after saslConnect() has
- been called.
-
- @param out
- the OutputStream to wrap
- @return a SASL wrapped OutputStream
- @throws IOException]]>
- </doc>
- </method>
- <method name="dispose"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SaslException" type="javax.security.sasl.SaslException"/>
- <doc>
- <![CDATA[Release resources used by wrapped saslClient]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A utility class that encapsulates SASL logic for RPC client]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcClient -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer -->
- <class name="SaslRpcServer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SaslRpcServer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getIdentifier" return="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="java.lang.String"/>
- <param name="secretManager" type="org.apache.hadoop.security.token.SecretManager"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- </method>
- <method name="splitKerberosName" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fullName" type="java.lang.String"/>
- <doc>
- <![CDATA[Splitting fully qualified Kerberos name into parts]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SASL_DEFAULT_REALM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SASL_PROPS" type="java.util.Map"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SWITCH_TO_SIMPLE_AUTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A utility class for dealing with SASL on RPC server]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer.AuthMethod -->
- <class name="SaslRpcServer.AuthMethod" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getMechanismName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the SASL mechanism name]]>
- </doc>
- </method>
- <method name="read" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read from in]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write to out]]>
- </doc>
- </method>
- <field name="SIMPLE" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KERBEROS" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DIGEST" type="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="code" type="byte"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The code for this method.]]>
- </doc>
- </field>
- <field name="mechanismName" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="authenticationMethod" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Authentication method]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer.AuthMethod -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer.QualityOfProtection -->
- <class name="SaslRpcServer.QualityOfProtection" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.SaslRpcServer.QualityOfProtection[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.SaslRpcServer.QualityOfProtection"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getSaslQop" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="AUTHENTICATION" type="org.apache.hadoop.security.SaslRpcServer.QualityOfProtection"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INTEGRITY" type="org.apache.hadoop.security.SaslRpcServer.QualityOfProtection"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PRIVACY" type="org.apache.hadoop.security.SaslRpcServer.QualityOfProtection"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="saslQop" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer.QualityOfProtection -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer.SaslDigestCallbackHandler -->
- <class name="SaslRpcServer.SaslDigestCallbackHandler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.security.auth.callback.CallbackHandler"/>
- <constructor name="SaslRpcServer.SaslDigestCallbackHandler" type="org.apache.hadoop.security.token.SecretManager, org.apache.hadoop.ipc.Server.Connection"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="handle"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callbacks" type="javax.security.auth.callback.Callback[]"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <exception name="UnsupportedCallbackException" type="javax.security.auth.callback.UnsupportedCallbackException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[CallbackHandler for SASL DIGEST-MD5 mechanism]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer.SaslDigestCallbackHandler -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer.SaslGssCallbackHandler -->
- <class name="SaslRpcServer.SaslGssCallbackHandler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.security.auth.callback.CallbackHandler"/>
- <constructor name="SaslRpcServer.SaslGssCallbackHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="handle"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="callbacks" type="javax.security.auth.callback.Callback[]"/>
- <exception name="UnsupportedCallbackException" type="javax.security.auth.callback.UnsupportedCallbackException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[CallbackHandler for SASL GSSAPI Kerberos mechanism]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer.SaslGssCallbackHandler -->
- <!-- start class org.apache.hadoop.security.SaslRpcServer.SaslStatus -->
- <class name="SaslRpcServer.SaslStatus" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.SaslRpcServer.SaslStatus[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.SaslRpcServer.SaslStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SUCCESS" type="org.apache.hadoop.security.SaslRpcServer.SaslStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ERROR" type="org.apache.hadoop.security.SaslRpcServer.SaslStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="state" type="int"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.SaslRpcServer.SaslStatus -->
- <!-- start class org.apache.hadoop.security.SecurityUtil -->
- <class name="SecurityUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecurityUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isOriginalTGT" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="fetchServiceTicket"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="remoteHost" type="java.net.URL"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Explicitly pull the service ticket for the specified host. This solves a
- problem with Java's Kerberos SSL problem where the client cannot
- authenticate against a cross-realm service. It is necessary for clients
- making kerberized https requests to call this method on the target URL
- to ensure that in a cross-realm environment the remote host will be
- successfully authenticated.
-
- This method is internal to Hadoop and should not be used by other
- applications. This method should not be considered stable or open:
- it will be removed when the Java behavior is changed.
-
- @param remoteHost Target URL the krb-https client will access
- @throws IOException if a service ticket is not available]]>
- </doc>
- </method>
- <method name="getServerPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalConfig" type="java.lang.String"/>
- <param name="hostname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert Kerberos principal name pattern to valid Kerberos principal
- names. It replaces hostname pattern with hostname, which should be
- fully-qualified domain name. If hostname is null or "0.0.0.0", it uses
- dynamically looked-up fqdn of the current host instead.
-
- @param principalConfig
- the Kerberos principal name conf value to convert
- @param hostname
- the fully-qualified domain name used for substitution
- @return converted Kerberos principal name
- @throws IOException if the service ticket cannot be retrieved]]>
- </doc>
- </method>
- <method name="getServerPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalConfig" type="java.lang.String"/>
- <param name="addr" type="java.net.InetAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convert Kerberos principal name pattern to valid Kerberos principal names.
- This method is similar to {@link #getServerPrincipal(String, String)},
- except 1) the reverse DNS lookup from addr to hostname is done only when
- necessary, 2) param addr can't be null (no default behavior of using local
- hostname when addr is null).
-
- @param principalConfig
- Kerberos principal name pattern to convert
- @param addr
- InetAddress of the host used for substitution
- @return converted Kerberos principal name
- @throws IOException if the client address cannot be determined]]>
- </doc>
- </method>
- <method name="getLocalHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Get the fqdn for the current host.
-
- @return fqdn of the current host.
- @throws UnknownHostException
- if no IP address for the local host could be found.]]>
- </doc>
- </method>
- <method name="login"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keytabFileKey" type="java.lang.String"/>
- <param name="userNameKey" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[If a keytab has been provided, login as that user. Substitute $host in
- user's Kerberos principal name with a dynamically looked-up fully-qualified
- domain name of the current host.
-
- @param conf
- conf to use
- @param keytabFileKey
- the key to look for keytab file in conf
- @param userNameKey
- the key to look for user's Kerberos principal name in conf
- @throws IOException if the client address cannot be determined]]>
- </doc>
- </method>
- <method name="login"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="keytabFileKey" type="java.lang.String"/>
- <param name="userNameKey" type="java.lang.String"/>
- <param name="hostname" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[If a keytab has been provided, login as that user. Substitute $host in
- user's Kerberos principal name with hostname.
-
- @param conf
- conf to use
- @param keytabFileKey
- the key to look for keytab file in conf
- @param userNameKey
- the key to look for user's Kerberos principal name in conf
- @param hostname
- hostname to use for substitution
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="getTokenServiceAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Decode the given token's service field into an InetAddress
- @param token from which to obtain the service
- @return InetAddress for the service]]>
- </doc>
- </method>
- <method name="setTokenService"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Set the given token's service to the format expected by the RPC client
- @param token a delegation token
- @param addr the socket for the rpc connection]]>
- </doc>
- </method>
- <method name="buildTokenService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.net.InetSocketAddress"/>
- <doc>
- <![CDATA[Construct the service key for a token
- @param addr InetSocketAddress of remote connection with a token
- @return "ip:port" or "host:port" depending on the value of
- hadoop.security.token.service.use_ip]]>
- </doc>
- </method>
- <method name="buildDTServiceName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="defPort" type="int"/>
- <doc>
- <![CDATA[create the service name for a Delegation token
- @param uri of the service
- @param defPort is used if the uri lacks a port
- @return the token service, or null if no authority
- @see #buildTokenService(InetSocketAddress)]]>
- </doc>
- </method>
- <method name="getAdminAcls" return="org.apache.hadoop.security.authorize.AccessControlList"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="configKey" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the ACL object representing the cluster administrators
- The user who starts the daemon is automatically added as an admin
- @param conf
- @param configKey the key that holds the ACL string in its value
- @return AccessControlList instance]]>
- </doc>
- </method>
- <method name="getHostFromPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="principalName" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the host name from the principal name of format <service>/host@realm.
- @param principalName principal name of format as described above
- @return host name if the the string conforms to the above format, else null]]>
- </doc>
- </method>
- <method name="useKsslAuth" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if we should use KSSL to authenticate NN HTTP endpoints,
- false to use SPNEGO or if security is disabled.]]>
- </doc>
- </method>
- <method name="openSecureHttpConnection" return="java.net.URLConnection"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open a (if need be) secure connection to a URL in a secure environment
- that is using SPNEGO or KSSL to authenticate its URLs. All Namenode and
- Secondary Namenode URLs that are protected via SPNEGO or KSSL should be
- accessed via this method.
- @param url to authenticate via SPNEGO.
- @return A connection that has been authenticated via SPNEGO
- @throws IOException If unable to authenticate via SPNEGO]]>
- </doc>
- </method>
- <method name="getByName" return="java.net.InetAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostname" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Resolves a host subject to the security requirements determined by
- hadoop.security.token.service.use_ip.
-
- @param hostname host or ip to resolve
- @return a resolved host
- @throws UnknownHostException if the host doesn't exist]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HOSTNAME_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.SecurityUtil -->
- <!-- start class org.apache.hadoop.security.SecurityUtil.QualifiedHostResolver -->
- <class name="SecurityUtil.QualifiedHostResolver" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.SecurityUtil.HostResolver"/>
- <constructor name="SecurityUtil.QualifiedHostResolver"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getByName" return="java.net.InetAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Create an InetAddress with a fully qualified hostname of the given
- hostname. InetAddress does not qualify an incomplete hostname that
- is resolved via the domain search list.
- {@link InetAddress#getCanonicalHostName()} will fully qualify the
- hostname, but it always return the A record whereas the given hostname
- may be a CNAME.
-
- @param host a hostname or ip address
- @return InetAddress with the fully qualified hostname or ip
- @throws UnknownHostException if host does not exist]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This an alternate resolver with important properties that the standard
- java resolver lacks:
- 1) The hostname is fully qualified. This avoids security issues if not
- all hosts in the cluster do not share the same search domains. It
- also prevents other hosts from performing unnecessary dns searches.
- In contrast, InetAddress simply returns the host as given.
- 2) The InetAddress is instantiated with an exact host and IP to prevent
- further unnecessary lookups. InetAddress may perform an unnecessary
- reverse lookup for an IP.
- 3) A call to getHostName() will always return the qualified hostname, or
- more importantly, the IP if instantiated with an IP. This avoids
- unnecessary dns timeouts if the host is not resolvable.
- 4) Point 3 also ensures that if the host is re-resolved, ex. during a
- connection re-attempt, that a reverse lookup to host and forward
- lookup to IP is not performed since the reverse/forward mappings may
- not always return the same IP. If the client initiated a connection
- with an IP, then that IP is all that should ever be contacted.
-
- NOTE: this resolver is only used if:
- hadoop.security.token.service.use_ip=false]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.SecurityUtil.QualifiedHostResolver -->
- <!-- start class org.apache.hadoop.security.ShellBasedUnixGroupsMapping -->
- <class name="ShellBasedUnixGroupsMapping" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.GroupMappingServiceProvider"/>
- <constructor name="ShellBasedUnixGroupsMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A simple shell-based implementation of {@link GroupMappingServiceProvider}
- that exec's the <code>groups</code> shell command to fetch the group
- memberships of a given user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.ShellBasedUnixGroupsMapping -->
- <!-- start class org.apache.hadoop.security.ShellBasedUnixGroupsNetgroupMapping -->
- <class name="ShellBasedUnixGroupsNetgroupMapping" extends="org.apache.hadoop.security.ShellBasedUnixGroupsMapping"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ShellBasedUnixGroupsNetgroupMapping"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroups" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsRefresh"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheGroupsAdd"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cacheNetgroup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getNetgroups"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="groups" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="execShellGetUnixGroups" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="execShellGetUserForNetgroup" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="netgroup" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="netgroupToUsersMapUpdated" type="boolean"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="netgroupToUsersMap" type="java.util.Map"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="userToNetgroupsMap" type="java.util.Map"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A simple shell-based implementation of {@link GroupMappingServiceProvider}
- that exec's the <code>groups</code> shell command to fetch the group
- memberships of a given user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.ShellBasedUnixGroupsNetgroupMapping -->
- <!-- start class org.apache.hadoop.security.UserGroupInformation -->
- <class name="UserGroupInformation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the static configuration for UGI.
- In particular, set the security authentication mechanism and the
- group look up service.
- @param conf the configuration to use]]>
- </doc>
- </method>
- <method name="isSecurityEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Determine if UserGroupInformation is using Kerberos to determine
- user identities or is relying on simple authentication
-
- @return true if UGI is working in a secure environment]]>
- </doc>
- </method>
- <method name="hasKerberosCredentials" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[checks if logged in using kerberos
- @return true if the subject logged via keytab or has a Kerberos TGT]]>
- </doc>
- </method>
- <method name="getCurrentUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the current user, including any doAs in the current stack.
- @return the current user
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="getLoginUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the currently logged in user.
- @return the logged in user
- @throws IOException if login fails]]>
- </doc>
- </method>
- <method name="isFromKeytab" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this user logged in from a keytab file?
- @return true if the credentials are from a keytab file.]]>
- </doc>
- </method>
- <method name="loginUserFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log a user in from a keytab file. Loads a user identity from a keytab
- file and logs them in. They become the currently logged-in user.
- @param user the principal name to load from the keytab
- @param path the path to the keytab file
- @throws IOException if the keytab file can't be read]]>
- </doc>
- </method>
- <method name="reloginFromTicketCache"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-Login a user in from the ticket cache. This
- method assumes that login had happened already.
- The Subject field of this UserGroupInformation object is updated to have
- the new credentials.
- @throws IOException on a failure]]>
- </doc>
- </method>
- <method name="loginUserFromKeytabAndReturnUGI" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log a user in from a keytab file. Loads a user identity from a keytab
- file and login them in. This new user does not affect the currently
- logged-in user.
- @param user the principal name to load from the keytab
- @param path the path to the keytab file
- @throws IOException if the keytab file can't be read]]>
- </doc>
- </method>
- <method name="checkTGTAndReloginFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-login a user from keytab if TGT is expired or is close to expiry.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="reloginFromKeytab"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Re-Login a user in from a keytab file. Loads a user identity from a keytab
- file and logs them in. They become the currently logged-in user. This
- method assumes that {@link #loginUserFromKeytab(String, String)} had
- happened already.
- The Subject field of this UserGroupInformation object is updated to have
- the new credentials.
- @throws IOException on a failure]]>
- </doc>
- </method>
- <method name="isLoginKeytabBased" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Did the login happen via keytab
- @return true or false]]>
- </doc>
- </method>
- <method name="createRemoteUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a user from a login name. It is intended to be used for remote
- users in RPC, since it won't have any credentials.
- @param user the full user principal name, must not be empty or null
- @return the UserGroupInformation for the remote user.]]>
- </doc>
- </method>
- <method name="createProxyUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="realUser" type="org.apache.hadoop.security.UserGroupInformation"/>
- <doc>
- <![CDATA[Create a proxy user using username of the effective user and the ugi of the
- real user.
- @param user
- @param realUser
- @return proxyUser ugi]]>
- </doc>
- </method>
- <method name="getRealUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get RealUser (vs. EffectiveUser)
- @return realUser running over proxy user]]>
- </doc>
- </method>
- <method name="createUserForTesting" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="userGroups" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Create a UGI for testing HDFS and MapReduce
- @param user the full user principal name
- @param userGroups the names of the groups that the user belongs to
- @return a fake user for running unit tests]]>
- </doc>
- </method>
- <method name="createProxyUserForTesting" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="realUser" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="userGroups" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Create a proxy user UGI for testing HDFS and MapReduce
-
- @param user
- the full user principal name for effective user
- @param realUser
- UGI of the real user
- @param userGroups
- the names of the groups that the user belongs to
- @return a fake user for running unit tests]]>
- </doc>
- </method>
- <method name="getShortUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user's login name.
- @return the user's name up to the first '/' or '@'.]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user's full principal name.
- @return the user's full principal name.]]>
- </doc>
- </method>
- <method name="addTokenIdentifier" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokenId" type="org.apache.hadoop.security.token.TokenIdentifier"/>
- <doc>
- <![CDATA[Add a TokenIdentifier to this UGI. The TokenIdentifier has typically been
- authenticated by the RPC layer as belonging to the user represented by this
- UGI.
-
- @param tokenId
- tokenIdentifier to be added
- @return true on successful add of new tokenIdentifier]]>
- </doc>
- </method>
- <method name="getTokenIdentifiers" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the set of TokenIdentifiers belonging to this UGI
-
- @return the set of TokenIdentifiers belonging to this UGI]]>
- </doc>
- </method>
- <method name="addToken" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add a token to this UGI
-
- @param token Token to be added
- @return true on successful add of new token]]>
- </doc>
- </method>
- <method name="getTokens" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the collection of tokens associated with this user.
-
- @return an unmodifiable collection of tokens associated with user]]>
- </doc>
- </method>
- <method name="getGroupNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the group names for this user.
- @return the list of users with the primary group first. If the command
- fails, it returns an empty list.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the username.]]>
- </doc>
- </method>
- <method name="setAuthenticationMethod"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authMethod" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"/>
- <doc>
- <![CDATA[Sets the authentication method in the subject
-
- @param authMethod]]>
- </doc>
- </method>
- <method name="getAuthenticationMethod" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the authentication method from the subject
-
- @return AuthenticationMethod in the subject, null if not present.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Compare the subjects to see if they are equal to each other.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the hash of the subject.]]>
- </doc>
- </method>
- <method name="getSubject" return="javax.security.auth.Subject"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the underlying subject from this ugi.
- @return the subject that represents this user.]]>
- </doc>
- </method>
- <method name="doAs" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedAction"/>
- <doc>
- <![CDATA[Run the given action as the user.
- @param <T> the return type of the run method
- @param action the method to execute
- @return the value from the run method]]>
- </doc>
- </method>
- <method name="doAs" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="action" type="java.security.PrivilegedExceptionAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Run the given action as the user, potentially throwing an exception.
- @param <T> the return type of the run method
- @param action the method to execute
- @return the value from the run method
- @throws IOException if the action throws an IOException
- @throws Error if the action throws an Error
- @throws RuntimeException if the action throws a RuntimeException
- @throws InterruptedException if the action throws an InterruptedException
- @throws UndeclaredThrowableException if the action throws something else]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[A test method to print out the current user's UGI.
- @param args if there are two arguments, read the user from the keytab
- and print it out.
- @throws Exception]]>
- </doc>
- </method>
- <field name="HADOOP_TOKEN_FILE_LOCATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variable pointing to the token cache file]]>
- </doc>
- </field>
- <doc>
- <![CDATA[User and group information for Hadoop.
- This class wraps around a JAAS Subject and provides methods to determine the
- user's username and groups. It supports both the Windows, Unix and Kerberos
- login modules.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.UserGroupInformation -->
- <!-- start class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
- <class name="UserGroupInformation.AuthenticationMethod" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SIMPLE" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KERBEROS" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOKEN" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CERTIFICATE" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KERBEROS_SSL" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PROXY" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[existing types of authentications' methods]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
- <!-- start class org.apache.hadoop.security.UserGroupInformation.HadoopLoginModule -->
- <class name="UserGroupInformation.HadoopLoginModule" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.security.auth.spi.LoginModule"/>
- <constructor name="UserGroupInformation.HadoopLoginModule"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="abort" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="LoginException" type="javax.security.auth.login.LoginException"/>
- </method>
- <method name="commit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="LoginException" type="javax.security.auth.login.LoginException"/>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subject" type="javax.security.auth.Subject"/>
- <param name="callbackHandler" type="javax.security.auth.callback.CallbackHandler"/>
- <param name="sharedState" type="java.util.Map"/>
- <param name="options" type="java.util.Map"/>
- </method>
- <method name="login" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="LoginException" type="javax.security.auth.login.LoginException"/>
- </method>
- <method name="logout" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="LoginException" type="javax.security.auth.login.LoginException"/>
- </method>
- <doc>
- <![CDATA[A login module that looks at the Kerberos, Unix, or Windows principal and
- adds the corresponding UserName.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.UserGroupInformation.HadoopLoginModule -->
- </package>
- <package name="org.apache.hadoop.security.authentication.client">
- <!-- start class org.apache.hadoop.security.authentication.client.AuthenticatedURL -->
- <class name="AuthenticatedURL" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthenticatedURL"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an {@link AuthenticatedURL}.]]>
- </doc>
- </constructor>
- <constructor name="AuthenticatedURL" type="org.apache.hadoop.security.authentication.client.Authenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an <code>AuthenticatedURL</code>.
- @param authenticator the {@link Authenticator} instance to use, if <code>null</code> a {@link
- KerberosAuthenticator} is used.]]>
- </doc>
- </constructor>
- <method name="setDefaultAuthenticator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="authenticator" type="java.lang.Class"/>
- <doc>
- <![CDATA[Sets the default {@link Authenticator} class to use when an {@link AuthenticatedURL} instance
- is created without specifying an authenticator.
- @param authenticator the authenticator class to use as default.]]>
- </doc>
- </method>
- <method name="getDefaultAuthenticator" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the default {@link Authenticator} class to use when an {@link AuthenticatedURL} instance
- is created without specifying an authenticator.
- @return the authenticator class to use as default.]]>
- </doc>
- </method>
- <method name="openConnection" return="java.net.HttpURLConnection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Returns an authenticated {@link HttpURLConnection}.
- @param url the URL to connect to. Only HTTP/S URLs are supported.
- @param token the authentication token being used for the user.
- @return an authenticated {@link HttpURLConnection}.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <method name="injectToken"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conn" type="java.net.HttpURLConnection"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <doc>
- <![CDATA[Helper method that injects an authentication token to send with a connection.
- @param conn connection to inject the authentication token into.
- @param token authentication token to inject.]]>
- </doc>
- </method>
- <method name="extractToken"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conn" type="java.net.HttpURLConnection"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Helper method that extracts an authentication token received from a connection.
- <p/>
- This method is used by {@link Authenticator} implementations.
- @param conn connection to extract the authentication token from.
- @param token the authentication token.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication exception occurred.]]>
- </doc>
- </method>
- <field name="AUTH_COOKIE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Name of the HTTP cookie used for the authentication token between the client and the server.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link AuthenticatedURL} class enables the use of the JDK {@link URL} class
- against HTTP endpoints protected with the {@link AuthenticationFilter}.
- <p/>
- The authentication mechanisms supported by default are Hadoop Simple authentication
- (also known as pseudo authentication) and Kerberos SPNEGO authentication.
- <p/>
- Additional authentication mechanisms can be supported via {@link Authenticator} implementations.
- <p/>
- The default {@link Authenticator} is the {@link KerberosAuthenticator} class which supports
- automatic fallback from Kerberos SPNEGO to Hadoop Simple authentication.
- <p/>
- <code>AuthenticatedURL</code> instances are not thread-safe.
- <p/>
- The usage pattern of the {@link AuthenticatedURL} is:
- <p/>
- <pre>
- // establishing an initial connection
- URL url = new URL("http://foo:8080/bar");
- AuthenticatedURL.Token token = new AuthenticatedURL.Token();
- AuthenticatedURL aUrl = new AuthenticatedURL();
- HttpURLConnection conn = new AuthenticatedURL(url, token).openConnection();
- ....
- // use the 'conn' instance
- ....
- // establishing a follow up connection using a token from the previous connection
- HttpURLConnection conn = new AuthenticatedURL(url, token).openConnection();
- ....
- // use the 'conn' instance
- ....
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.client.AuthenticatedURL -->
- <!-- start class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token -->
- <class name="AuthenticatedURL.Token" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthenticatedURL.Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a token.]]>
- </doc>
- </constructor>
- <constructor name="AuthenticatedURL.Token" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a token using an existing string representation of the token.
- @param tokenStr string representation of the tokenStr.]]>
- </doc>
- </constructor>
- <method name="isSet" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if a token from the server has been set.
- @return if a token from the server has been set.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the string representation of the token.
- @return the string representation of the token.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the hashcode for the token.
- @return the hashcode for the token.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return if two token instances are equal.
- @param o the other token instance.
- @return if this instance and the other instance are equal.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Client side authentication token.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token -->
- <!-- start class org.apache.hadoop.security.authentication.client.AuthenticationException -->
- <class name="AuthenticationException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthenticationException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an {@link AuthenticationException}.
- @param cause original exception.]]>
- </doc>
- </constructor>
- <constructor name="AuthenticationException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an {@link AuthenticationException}.
- @param msg exception message.]]>
- </doc>
- </constructor>
- <constructor name="AuthenticationException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an {@link AuthenticationException}.
- @param msg exception message.
- @param cause original exception.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Exception thrown when an authentication error occurrs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.client.AuthenticationException -->
- <!-- start interface org.apache.hadoop.security.authentication.client.Authenticator -->
- <interface name="Authenticator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="authenticate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Authenticates against a URL and returns a {@link AuthenticatedURL.Token} to be
- used by subsequent requests.
- @param url the URl to authenticate against.
- @param token the authentication token being used for the user.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication error occurred.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for client authentication mechanisms.
- <p/>
- Implementations are use-once instances, they don't need to be thread safe.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.authentication.client.Authenticator -->
- <!-- start class org.apache.hadoop.security.authentication.client.KerberosAuthenticator -->
- <class name="KerberosAuthenticator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authentication.client.Authenticator"/>
- <constructor name="KerberosAuthenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="authenticate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Performs SPNEGO authentication against the specified URL.
- <p/>
- If a token is given it does a NOP and returns the given token.
- <p/>
- If no token is given, it will perform the SPNEGO authentication sequence using an
- HTTP <code>OPTIONS</code> request.
- @param url the URl to authenticate against.
- @param token the authentication token being used for the user.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication error occurred.]]>
- </doc>
- </method>
- <method name="getFallBackAuthenticator" return="org.apache.hadoop.security.authentication.client.Authenticator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the specified URL does not support SPNEGO authentication, a fallback {@link Authenticator} will be used.
- <p/>
- This implementation returns a {@link PseudoAuthenticator}.
- @return the fallback {@link Authenticator}.]]>
- </doc>
- </method>
- <field name="WWW_AUTHENTICATE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HTTP header used by the SPNEGO server endpoint during an authentication sequence.]]>
- </doc>
- </field>
- <field name="AUTHORIZATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HTTP header used by the SPNEGO client endpoint during an authentication sequence.]]>
- </doc>
- </field>
- <field name="NEGOTIATE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HTTP header prefix used by the SPNEGO client/server endpoints during an authentication sequence.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link KerberosAuthenticator} implements the Kerberos SPNEGO authentication sequence.
- <p/>
- It uses the default principal for the Kerberos cache (normally set via kinit).
- <p/>
- It falls back to the {@link PseudoAuthenticator} if the HTTP endpoint does not trigger an SPNEGO authentication
- sequence.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.client.KerberosAuthenticator -->
- <!-- start class org.apache.hadoop.security.authentication.client.PseudoAuthenticator -->
- <class name="PseudoAuthenticator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authentication.client.Authenticator"/>
- <constructor name="PseudoAuthenticator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="authenticate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <param name="token" type="org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Performs simple authentication against the specified URL.
- <p/>
- If a token is given it does a NOP and returns the given token.
- <p/>
- If no token is given, it will perform an HTTP <code>OPTIONS</code> request injecting an additional
- parameter {@link #USER_NAME} in the query string with the value returned by the {@link #getUserName()}
- method.
- <p/>
- If the response is successful it will update the authentication token.
- @param url the URl to authenticate against.
- @param token the authencation token being used for the user.
- @throws IOException if an IO error occurred.
- @throws AuthenticationException if an authentication error occurred.]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current user name.
- <p/>
- This implementation returns the value of the Java system property 'user.name'
- @return the current user name.]]>
- </doc>
- </method>
- <field name="USER_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Name of the additional parameter that carries the 'user.name' value.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link PseudoAuthenticator} implementation provides an authentication equivalent to Hadoop's
- Simple authentication, it trusts the value of the 'user.name' Java System property.
- <p/>
- The 'user.name' value is propagated using an additional query string parameter {@link #USER_NAME} ('user.name').]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.client.PseudoAuthenticator -->
- </package>
- <package name="org.apache.hadoop.security.authentication.server">
- <!-- start class org.apache.hadoop.security.authentication.server.AuthenticationFilter -->
- <class name="AuthenticationFilter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="javax.servlet.Filter"/>
- <constructor name="AuthenticationFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filterConfig" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Initializes the authentication filter.
- <p/>
- It instantiates and initializes the specified {@link AuthenticationHandler}.
- <p/>
- @param filterConfig filter configuration.
- @throws ServletException thrown if the filter or the authentication handler could not be initialized properly.]]>
- </doc>
- </method>
- <method name="getAuthenticationHandler" return="org.apache.hadoop.security.authentication.server.AuthenticationHandler"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the authentication handler being used.
- @return the authentication handler being used.]]>
- </doc>
- </method>
- <method name="isRandomSecret" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if a random secret is being used.
- @return if a random secret is being used.]]>
- </doc>
- </method>
- <method name="getValidity" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the validity time of the generated tokens.
- @return the validity time of the generated tokens, in seconds.]]>
- </doc>
- </method>
- <method name="getCookieDomain" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the cookie domain to use for the HTTP cookie.
- @return the cookie domain to use for the HTTP cookie.]]>
- </doc>
- </method>
- <method name="getCookiePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the cookie path to use for the HTTP cookie.
- @return the cookie path to use for the HTTP cookie.]]>
- </doc>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Destroys the filter.
- <p/>
- It invokes the {@link AuthenticationHandler#destroy()} method to release any resources it may hold.]]>
- </doc>
- </method>
- <method name="getConfiguration" return="java.util.Properties"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="configPrefix" type="java.lang.String"/>
- <param name="filterConfig" type="javax.servlet.FilterConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Returns the filtered configuration (only properties starting with the specified prefix). The property keys
- are also trimmed from the prefix. The returned {@link Properties} object is used to initialized the
- {@link AuthenticationHandler}.
- <p/>
- This method can be overriden by subclasses to obtain the configuration from other configuration source than
- the web.xml file.
- @param configPrefix configuration prefix to use for extracting configuration properties.
- @param filterConfig filter configuration object
- @return the configuration to be used with the {@link AuthenticationHandler} instance.
- @throws ServletException thrown if the configuration could not be created.]]>
- </doc>
- </method>
- <method name="getRequestURL" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <doc>
- <![CDATA[Returns the full URL of the request including the query string.
- <p/>
- Used as a convenience method for logging purposes.
- @param request the request object.
- @return the full URL of the request including the query string.]]>
- </doc>
- </method>
- <method name="getToken" return="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Returns the {@link AuthenticationToken} for the request.
- <p/>
- It looks at the received HTTP cookies and extracts the value of the {@link AuthenticatedURL#AUTH_COOKIE}
- if present. It verifies the signature and if correct it creates the {@link AuthenticationToken} and returns
- it.
- <p/>
- If this method returns <code>null</code> the filter will invoke the configured {@link AuthenticationHandler}
- to perform user authentication.
- @param request request object.
- @return the Authentication token if the request is authenticated, <code>null</code> otherwise.
- @throws IOException thrown if an IO error occurred.
- @throws AuthenticationException thrown if the token is invalid or if it has expired.]]>
- </doc>
- </method>
- <method name="doFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.ServletRequest"/>
- <param name="response" type="javax.servlet.ServletResponse"/>
- <param name="filterChain" type="javax.servlet.FilterChain"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[If the request has a valid authentication token it allows the request to continue to the target resource,
- otherwise it triggers an authentication sequence using the configured {@link AuthenticationHandler}.
- @param request the request object.
- @param response the response object.
- @param filterChain the filter chain object.
- @throws IOException thrown if an IO error occurred.
- @throws ServletException thrown if a processing error occurred.]]>
- </doc>
- </method>
- <method name="createCookie" return="javax.servlet.http.Cookie"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="token" type="java.lang.String"/>
- <doc>
- <![CDATA[Creates the Hadoop authentiation HTTP cookie.
- <p/>
- It sets the domain and path specified in the configuration.
- @param token authentication token for the cookie.
- @return the HTTP cookie.]]>
- </doc>
- </method>
- <field name="CONFIG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the property that specifies the configuration prefix.]]>
- </doc>
- </field>
- <field name="AUTH_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the property that specifies the authentication handler to use.]]>
- </doc>
- </field>
- <field name="SIGNATURE_SECRET" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the property that specifies the secret to use for signing the HTTP Cookies.]]>
- </doc>
- </field>
- <field name="AUTH_TOKEN_VALIDITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the validity of the generated token.]]>
- </doc>
- </field>
- <field name="COOKIE_DOMAIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the domain to use in the HTTP cookie.]]>
- </doc>
- </field>
- <field name="COOKIE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the path to use in the HTTP cookie.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link AuthenticationFilter} enables protecting web application resources with different (pluggable)
- authentication mechanisms.
- <p/>
- Out of the box it provides 2 authentication mechanisms: Pseudo and Kerberos SPNEGO.
- <p/>
- Additional authentication mechanisms are supported via the {@link AuthenticationHandler} interface.
- <p/>
- This filter delegates to the configured authentication handler for authentication and once it obtains an
- {@link AuthenticationToken} from it, sets a signed HTTP cookie with the token. For client requests
- that provide the signed HTTP cookie, it verifies the validity of the cookie, extracts the user information
- and lets the request proceed to the target resource.
- <p/>
- The supported configuration properties are:
- <ul>
- <li>config.prefix: indicates the prefix to be used by all other configuration properties, the default value
- is no prefix. See below for details on how/why this prefix is used.</li>
- <li>[#PREFIX#.]type: simple|kerberos|#CLASS#, 'simple' is short for the
- {@link PseudoAuthenticationHandler}, 'kerberos' is short for {@link KerberosAuthenticationHandler}, otherwise
- the full class name of the {@link AuthenticationHandler} must be specified.</li>
- <li>[#PREFIX#.]signature.secret: the secret used to sign the HTTP cookie value. The default value is a random
- value. Unless multiple webapp instances need to share the secret the random value is adequate.</li>
- <li>[#PREFIX#.]token.validity: time -in seconds- that the generated token is valid before a
- new authentication is triggered, default value is <code>3600</code> seconds.</li>
- <li>[#PREFIX#.]cookie.domain: domain to use for the HTTP cookie that stores the authentication token.</li>
- <li>[#PREFIX#.]cookie.path: path to use for the HTTP cookie that stores the authentication token.</li>
- </ul>
- <p/>
- The rest of the configuration properties are specific to the {@link AuthenticationHandler} implementation and the
- {@link AuthenticationFilter} will take all the properties that start with the prefix #PREFIX#, it will remove
- the prefix from it and it will pass them to the the authentication handler for initialization. Properties that do
- not start with the prefix will not be passed to the authentication handler initialization.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.server.AuthenticationFilter -->
- <!-- start interface org.apache.hadoop.security.authentication.server.AuthenticationHandler -->
- <interface name="AuthenticationHandler" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the authentication type of the authentication handler.
- <p/>
- This should be a name that uniquely identifies the authentication type.
- For example 'simple' or 'kerberos'.
- @return the authentication type of the authentication handler.]]>
- </doc>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="java.util.Properties"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Initializes the authentication handler instance.
- <p/>
- This method is invoked by the {@link AuthenticationFilter#init} method.
- @param config configuration properties to initialize the handler.
- @throws ServletException thrown if the handler could not be initialized.]]>
- </doc>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Destroys the authentication handler instance.
- <p/>
- This method is invoked by the {@link AuthenticationFilter#destroy} method.]]>
- </doc>
- </method>
- <method name="authenticate" return="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Performs an authentication step for the given HTTP client request.
- <p/>
- This method is invoked by the {@link AuthenticationFilter} only if the HTTP client request is
- not yet authenticated.
- <p/>
- Depending upon the authentication mechanism being implemented, a particular HTTP client may
- end up making a sequence of invocations before authentication is successfully established (this is
- the case of Kerberos SPNEGO).
- <p/>
- This method must return an {@link AuthenticationToken} only if the the HTTP client request has
- been successfully and fully authenticated.
- <p/>
- If the HTTP client request has not been completely authenticated, this method must take over
- the corresponding HTTP response and it must return <code>null</code>.
- @param request the HTTP client request.
- @param response the HTTP client response.
- @return an {@link AuthenticationToken} if the HTTP client request has been authenticated,
- <code>null</code> otherwise (in this case it must take care of the response).
- @throws IOException thrown if an IO error occurred.
- @throws AuthenticationException thrown if an Authentication error occurred.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for server authentication mechanisms.
- <p/>
- The {@link AuthenticationFilter} manages the lifecycle of the authentication handler.
- <p/>
- Implementations must be thread-safe as one instance is initialized and used for all requests.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.authentication.server.AuthenticationHandler -->
- <!-- start class org.apache.hadoop.security.authentication.server.AuthenticationToken -->
- <class name="AuthenticationToken" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.security.Principal"/>
- <constructor name="AuthenticationToken" type="java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an authentication token.
- @param userName user name.
- @param principal principal (commonly matches the user name, with Kerberos is the full/long principal
- name while the userName is the short name).
- @param type the authentication mechanism name.
- (<code>System.currentTimeMillis() + validityPeriod</code>).]]>
- </doc>
- </constructor>
- <method name="setExpires"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expires" type="long"/>
- <doc>
- <![CDATA[Sets the expiration of the token.
- @param expires expiration time of the token in milliseconds since the epoch.]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the user name.
- @return the user name.]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the principal name (this method name comes from the JDK {@link Principal} interface).
- @return the principal name.]]>
- </doc>
- </method>
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the authentication mechanism of the token.
- @return the authentication mechanism of the token.]]>
- </doc>
- </method>
- <method name="getExpires" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the expiration time of the token.
- @return the expiration time of the token, in milliseconds since Epoc.]]>
- </doc>
- </method>
- <method name="isExpired" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if the token has expired.
- @return if the token has expired.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the string representation of the token.
- <p/>
- This string representation is parseable by the {@link #parse} method.
- @return the string representation of the token.]]>
- </doc>
- </method>
- <method name="parse" return="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokenStr" type="java.lang.String"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Parses a string into an authentication token.
- @param tokenStr string representation of a token.
- @return the parsed authentication token.
- @throws AuthenticationException thrown if the string representation could not be parsed into
- an authentication token.]]>
- </doc>
- </method>
- <field name="ANONYMOUS" type="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant that identifies an anonymous request.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link AuthenticationToken} contains information about an authenticated
- HTTP client and doubles as the {@link Principal} to be returned by
- authenticated {@link HttpServletRequest}s
- <p/>
- The token can be serialized/deserialized to and from a string as it is sent
- and received in HTTP client responses and requests as a HTTP cookie (this is
- done by the {@link AuthenticationFilter}).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.server.AuthenticationToken -->
- <!-- start class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler -->
- <class name="KerberosAuthenticationHandler" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authentication.server.AuthenticationHandler"/>
- <constructor name="KerberosAuthenticationHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="java.util.Properties"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Initializes the authentication handler instance.
- <p/>
- It creates a Kerberos context using the principal and keytab specified in the configuration.
- <p/>
- This method is invoked by the {@link AuthenticationFilter#init} method.
- @param config configuration properties to initialize the handler.
- @throws ServletException thrown if the handler could not be initialized.]]>
- </doc>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Releases any resources initialized by the authentication handler.
- <p/>
- It destroys the Kerberos context.]]>
- </doc>
- </method>
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the authentication type of the authentication handler, 'kerberos'.
- <p/>
- @return the authentication type of the authentication handler, 'kerberos'.]]>
- </doc>
- </method>
- <method name="getPrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the Kerberos principal used by the authentication handler.
- @return the Kerberos principal used by the authentication handler.]]>
- </doc>
- </method>
- <method name="getKeytab" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the keytab used by the authentication handler.
- @return the keytab used by the authentication handler.]]>
- </doc>
- </method>
- <method name="authenticate" return="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[It enforces the the Kerberos SPNEGO authentication sequence returning an {@link AuthenticationToken} only
- after the Kerberos SPNEGO sequence has completed successfully.
- <p/>
- @param request the HTTP client request.
- @param response the HTTP client response.
- @return an authentication token if the Kerberos SPNEGO sequence is complete and valid,
- <code>null</code> if it is in progress (in this case the handler handles the response to the client).
- @throws IOException thrown if an IO error occurred.
- @throws AuthenticationException thrown if Kerberos SPNEGO sequence failed.]]>
- </doc>
- </method>
- <field name="TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant that identifies the authentication mechanism.]]>
- </doc>
- </field>
- <field name="PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the kerberos principal.]]>
- </doc>
- </field>
- <field name="KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the keytab file path.]]>
- </doc>
- </field>
- <field name="NAME_RULES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates the Kerberos name
- rules for the Kerberos principals.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The {@link KerberosAuthenticationHandler} implements the Kerberos SPNEGO authentication mechanism for HTTP.
- <p/>
- The supported configuration properties are:
- <ul>
- <li>kerberos.principal: the Kerberos principal to used by the server. As stated by the Kerberos SPNEGO
- specification, it should be <code>HTTP/${HOSTNAME}@{REALM}</code>. The realm can be omitted from the
- principal as the JDK GSS libraries will use the realm name of the configured default realm.
- It does not have a default value.</li>
- <li>kerberos.keytab: the keytab file containing the credentials for the Kerberos principal.
- It does not have a default value.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler -->
- <!-- start class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler -->
- <class name="PseudoAuthenticationHandler" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.authentication.server.AuthenticationHandler"/>
- <constructor name="PseudoAuthenticationHandler"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="config" type="java.util.Properties"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <doc>
- <![CDATA[Initializes the authentication handler instance.
- <p/>
- This method is invoked by the {@link AuthenticationFilter#init} method.
- @param config configuration properties to initialize the handler.
- @throws ServletException thrown if the handler could not be initialized.]]>
- </doc>
- </method>
- <method name="getAcceptAnonymous" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns if the handler is configured to support anonymous users.
- @return if the handler is configured to support anonymous users.]]>
- </doc>
- </method>
- <method name="destroy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Releases any resources initialized by the authentication handler.
- <p/>
- This implementation does a NOP.]]>
- </doc>
- </method>
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the authentication type of the authentication handler, 'simple'.
- <p/>
- @return the authentication type of the authentication handler, 'simple'.]]>
- </doc>
- </method>
- <method name="authenticate" return="org.apache.hadoop.security.authentication.server.AuthenticationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="AuthenticationException" type="org.apache.hadoop.security.authentication.client.AuthenticationException"/>
- <doc>
- <![CDATA[Authenticates an HTTP client request.
- <p/>
- It extracts the {@link PseudoAuthenticator#USER_NAME} parameter from the query string and creates
- an {@link AuthenticationToken} with it.
- <p/>
- If the HTTP client request does not contain the {@link PseudoAuthenticator#USER_NAME} parameter and
- the handler is configured to allow anonymous users it returns the {@link AuthenticationToken#ANONYMOUS}
- token.
- <p/>
- If the HTTP client request does not contain the {@link PseudoAuthenticator#USER_NAME} parameter and
- the handler is configured to disallow anonymous users it throws an {@link AuthenticationException}.
- @param request the HTTP client request.
- @param response the HTTP client response.
- @return an authentication token if the HTTP client request is accepted and credentials are valid.
- @throws IOException thrown if an IO error occurred.
- @throws AuthenticationException thrown if HTTP client request was not accepted as an authentication request.]]>
- </doc>
- </method>
- <field name="TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant that identifies the authentication mechanism.]]>
- </doc>
- </field>
- <field name="ANONYMOUS_ALLOWED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant for the configuration property that indicates if anonymous users are allowed.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The <code>PseudoAuthenticationHandler</code> provides a pseudo authentication mechanism that accepts
- the user name specified as a query string parameter.
- <p/>
- This mimics the model of Hadoop Simple authentication which trust the 'user.name' property provided in
- the configuration object.
- <p/>
- This handler can be configured to support anonymous users.
- <p/>
- The only supported configuration property is:
- <ul>
- <li>simple.anonymous.allowed: <code>true|false</code>, default value is <code>false</code></li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.server.PseudoAuthenticationHandler -->
- </package>
- <package name="org.apache.hadoop.security.authentication.util">
- <!-- start class org.apache.hadoop.security.authentication.util.KerberosUtil -->
- <class name="KerberosUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KerberosUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKrb5LoginModuleName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOidInstance" return="org.ietf.jgss.Oid"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="oidName" type="java.lang.String"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="GSSException" type="org.ietf.jgss.GSSException"/>
- <exception name="NoSuchFieldException" type="java.lang.NoSuchFieldException"/>
- <exception name="IllegalAccessException" type="java.lang.IllegalAccessException"/>
- </method>
- <method name="getDefaultRealm" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="NoSuchMethodException" type="java.lang.NoSuchMethodException"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <exception name="IllegalAccessException" type="java.lang.IllegalAccessException"/>
- <exception name="InvocationTargetException" type="java.lang.reflect.InvocationTargetException"/>
- </method>
- <method name="getServicePrincipal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="java.lang.String"/>
- <param name="hostname" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Create Kerberos principal for a given service and hostname. It converts
- hostname to lower case. If hostname is null or "0.0.0.0", it uses
- dynamically looked-up fqdn of the current host instead.
-
- @param service
- Service for which you want to generate the principal.
- @param hostname
- Fully-qualified domain name.
- @return Converted Kerberos principal name.
- @throws UnknownHostException
- If no IP address for the local host could be found.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.util.KerberosUtil -->
- <!-- start class org.apache.hadoop.security.authentication.util.Signer -->
- <class name="Signer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Signer" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a Signer instance using the specified secret.
- @param secret secret to use for creating the digest.]]>
- </doc>
- </constructor>
- <method name="sign" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a signed string.
- <p/>
- The signature '&s=SIGNATURE' is appended at the end of the string.
- @param str string to sign.
- @return the signed string.]]>
- </doc>
- </method>
- <method name="verifyAndExtract" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="signedStr" type="java.lang.String"/>
- <exception name="SignerException" type="org.apache.hadoop.security.authentication.util.SignerException"/>
- <doc>
- <![CDATA[Verifies a signed string and extracts the original string.
- @param signedStr the signed string to verify and extract.
- @return the extracted original string.
- @throws SignerException thrown if the given string is not a signed string or if the signature is invalid.]]>
- </doc>
- </method>
- <method name="computeSignature" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns then signature of a string.
- @param str string to sign.
- @return the signature for the string.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Signs strings and verifies signed strings using a SHA digest.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.util.Signer -->
- <!-- start class org.apache.hadoop.security.authentication.util.SignerException -->
- <class name="SignerException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SignerException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates an exception instance.
- @param msg message for the exception.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Exception thrown by {@link Signer} when a string signature is invalid.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authentication.util.SignerException -->
- </package>
- <package name="org.apache.hadoop.security.authorize">
- <!-- start class org.apache.hadoop.security.authorize.AccessControlList -->
- <class name="AccessControlList" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="AccessControlList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor exists primarily for AccessControlList to be Writable.]]>
- </doc>
- </constructor>
- <constructor name="AccessControlList" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new ACL from a String representation of the same.
-
- The String is a a comma separated list of users and groups.
- The user list comes first and is separated by a space followed
- by the group list. For e.g. "user1,user2 group1,group2"
-
- @param aclString String representation of the ACL]]>
- </doc>
- </constructor>
- <method name="isAllAllowed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="isUserAllowed" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getACLString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the String representation of this ACL. Unlike toString() method's
- return value, this String can be directly given to the constructor of
- AccessControlList to build AccessControlList object.
- This is the method used by the serialization method write().]]>
- </doc>
- </method>
- <field name="WILDCARD_ACL_VALUE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Class representing a configured access control list.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.AccessControlList -->
- <!-- start class org.apache.hadoop.security.authorize.AuthorizationException -->
- <class name="AuthorizationException" extends="org.apache.hadoop.security.AccessControlException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuthorizationException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AuthorizationException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AuthorizationException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a new exception with the specified cause and a detail
- message of <tt>(cause==null ? null : cause.toString())</tt> (which
- typically contains the class and detail message of <tt>cause</tt>).
- @param cause the cause (which is saved for later retrieval by the
- {@link #getCause()} method). (A <tt>null</tt> value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)]]>
- </doc>
- </constructor>
- <method name="getStackTrace" return="java.lang.StackTraceElement[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.io.PrintStream"/>
- </method>
- <method name="printStackTrace"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.io.PrintWriter"/>
- </method>
- <doc>
- <![CDATA[An exception class for authorization-related issues.
-
- This class <em>does not</em> provide the stack trace for security purposes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.AuthorizationException -->
- <!-- start class org.apache.hadoop.security.authorize.PolicyProvider -->
- <class name="PolicyProvider" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PolicyProvider"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getServices" return="org.apache.hadoop.security.authorize.Service[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Service} definitions from the {@link PolicyProvider}.
- @return the {@link Service} definitions]]>
- </doc>
- </method>
- <field name="POLICY_PROVIDER_CONFIG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key for the {@link PolicyProvider} implementation.]]>
- </doc>
- </field>
- <field name="DEFAULT_POLICY_PROVIDER" type="org.apache.hadoop.security.authorize.PolicyProvider"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A default {@link PolicyProvider} without any defined services.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[{@link PolicyProvider} provides the {@link Service} definitions to the
- security {@link Policy} in effect for Hadoop.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.PolicyProvider -->
- <!-- start class org.apache.hadoop.security.authorize.ProxyUsers -->
- <class name="ProxyUsers" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ProxyUsers"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="refreshSuperUserGroupsConfiguration"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reread the conf and get new values for "hadoop.proxyuser.*.groups/hosts"]]>
- </doc>
- </method>
- <method name="refreshSuperUserGroupsConfiguration"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[refresh configuration
- @param conf]]>
- </doc>
- </method>
- <method name="getProxySuperuserGroupConfKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns configuration key for effective user groups allowed for a superuser
-
- @param userName name of the superuser
- @return configuration key for superuser groups]]>
- </doc>
- </method>
- <method name="getProxySuperuserIpConfKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userName" type="java.lang.String"/>
- <doc>
- <![CDATA[Return configuration key for superuser ip addresses
-
- @param userName name of the superuser
- @return configuration key for superuser ip-addresses]]>
- </doc>
- </method>
- <method name="authorize"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="remoteAddress" type="java.lang.String"/>
- <param name="newConf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="AuthorizationException" type="org.apache.hadoop.security.authorize.AuthorizationException"/>
- <doc>
- <![CDATA[Authorize the superuser which is doing doAs
-
- @param user ugi of the effective or proxy user which contains a real user
- @param remoteAddress the ip address of client
- @param newConf configuration
- @throws AuthorizationException]]>
- </doc>
- </method>
- <field name="CONF_GROUPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_HADOOP_PROXYUSER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_HADOOP_PROXYUSER_RE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.ProxyUsers -->
- <!-- start interface org.apache.hadoop.security.authorize.RefreshAuthorizationPolicyProtocol -->
- <interface name="RefreshAuthorizationPolicyProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- <method name="refreshServiceAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh the service-level authorization policy in-effect.
- @throws IOException]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Version 1: Initial version]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Protocol which is used to refresh the authorization policy in use currently.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.authorize.RefreshAuthorizationPolicyProtocol -->
- <!-- start class org.apache.hadoop.security.authorize.Service -->
- <class name="Service" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Service" type="java.lang.String, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getServiceKey" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configuration key for the service.
- @return the configuration key for the service]]>
- </doc>
- </method>
- <method name="getProtocol" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the protocol for the service
- @return the {@link Class} for the protocol]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An abstract definition of <em>service</em> as related to
- Service Level Authorization for Hadoop.
-
- Each service defines it's configuration key and also the necessary
- {@link Permission} required to access the service.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.Service -->
- <!-- start class org.apache.hadoop.security.authorize.ServiceAuthorizationManager -->
- <class name="ServiceAuthorizationManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ServiceAuthorizationManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="authorize"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="org.apache.hadoop.security.UserGroupInformation"/>
- <param name="protocol" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="addr" type="java.net.InetAddress"/>
- <exception name="AuthorizationException" type="org.apache.hadoop.security.authorize.AuthorizationException"/>
- <doc>
- <![CDATA[Authorize the user to access the protocol being used.
-
- @param user user accessing the service
- @param protocol service being accessed
- @param conf configuration to use
- @param addr InetAddress of the client
- @throws AuthorizationException on authorization failure]]>
- </doc>
- </method>
- <method name="refresh"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="provider" type="org.apache.hadoop.security.authorize.PolicyProvider"/>
- </method>
- <field name="SERVICE_AUTHORIZATION_CONFIG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Use
- {@link CommonConfigurationKeys#HADOOP_SECURITY_AUTHORIZATION}
- instead.">
- <doc>
- <![CDATA[Configuration key for controlling service-level authorization for Hadoop.
-
- @deprecated Use
- {@link CommonConfigurationKeys#HADOOP_SECURITY_AUTHORIZATION}
- instead.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An authorization manager which handles service-level authorization
- for incoming service requests.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.authorize.ServiceAuthorizationManager -->
- </package>
- <package name="org.apache.hadoop.security.token">
- <!-- start class org.apache.hadoop.security.token.SecretManager -->
- <class name="SecretManager" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createPassword" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.security.token.TokenIdentifier"/>
- <doc>
- <![CDATA[Create the password for the given identifier.
- identifier may be modified inside this method.
- @param identifier the identifier to use
- @return the new password]]>
- </doc>
- </method>
- <method name="retrievePassword" return="byte[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.security.token.TokenIdentifier"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <doc>
- <![CDATA[Retrieve the password for the given token identifier. Should check the date
- or registry to make sure the token hasn't expired or been revoked. Returns
- the relevant password.
- @param identifier the identifier to validate
- @return the password to use
- @throws InvalidToken the token was invalid]]>
- </doc>
- </method>
- <method name="createIdentifier" return="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty token identifier.
- @return the newly created empty token identifier]]>
- </doc>
- </method>
- <method name="generateSecret" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate a new random secret key.
- @return the new key]]>
- </doc>
- </method>
- <method name="createPassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="identifier" type="byte[]"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <doc>
- <![CDATA[Compute HMAC of the identifier using the secret key and return the
- output as password
- @param identifier the bytes of the identifier
- @param key the secret key
- @return the bytes of the generated password]]>
- </doc>
- </method>
- <method name="createSecretKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Convert the byte[] to a secret key
- @param key the byte[] to create a secret key from
- @return the secret key]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The server-side secret manager for each token type.
- @param <T> The type of the token identifier]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.SecretManager -->
- <!-- start class org.apache.hadoop.security.token.SecretManager.InvalidToken -->
- <class name="SecretManager.InvalidToken" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecretManager.InvalidToken" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The token was invalid and the message explains why.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.SecretManager.InvalidToken -->
- <!-- start class org.apache.hadoop.security.token.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Token" type="org.apache.hadoop.security.token.TokenIdentifier, org.apache.hadoop.security.token.SecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a token given a token identifier and a secret manager for the
- type of the token identifier.
- @param id the token identifier
- @param mgr the secret manager]]>
- </doc>
- </constructor>
- <constructor name="Token" type="byte[], byte[], org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a token from the components.
- @param identifier the token identifier
- @param password the token's password
- @param kind the kind of token
- @param service the service for this token]]>
- </doc>
- </constructor>
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor]]>
- </doc>
- </constructor>
- <constructor name="Token" type="org.apache.hadoop.security.token.Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clone a token.
- @param other the token to clone]]>
- </doc>
- </constructor>
- <method name="getIdentifier" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token identifier
- @return the token identifier]]>
- </doc>
- </method>
- <method name="getPassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token password/secret
- @return the token password/secret]]>
- </doc>
- </method>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind
- @return the kind of the token]]>
- </doc>
- </method>
- <method name="setKind"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newKind" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Set the token kind. This is only intended to be used by services that
- wrap another service's token, such as HFTP wrapping HDFS.
- @param newKind]]>
- </doc>
- </method>
- <method name="getService" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the service on which the token is supposed to be used
- @return the service name]]>
- </doc>
- </method>
- <method name="setService"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newService" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Set the service on which the token is supposed to be used
- @param newService the service name]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="encodeToUrlString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Encode this token as a url safe string
- @return the encoded string
- @throws IOException]]>
- </doc>
- </method>
- <method name="decodeFromUrlString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Decode the given url safe string into this token.
- @param newValue the encoded string
- @throws IOException]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="right" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isManaged" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Is this token managed so that it can be renewed or cancelled?
- @return true, if it can be renewed and cancelled.]]>
- </doc>
- </method>
- <method name="renew" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew this delegation token
- @return the new expiration time
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Cancel this delegation token
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The client-side form of the token.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.Token -->
- <!-- start class org.apache.hadoop.security.token.Token.TrivialRenewer -->
- <class name="Token.TrivialRenewer" extends="org.apache.hadoop.security.token.TokenRenewer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Token.TrivialRenewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="handleKind" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="kind" type="org.apache.hadoop.io.Text"/>
- </method>
- <method name="isManaged" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- </method>
- <method name="renew" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[A trivial renewer for token kinds that aren't managed. Sub-classes need
- to implement getKind for their token kind.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.Token.TrivialRenewer -->
- <!-- start class org.apache.hadoop.security.token.TokenIdentifier -->
- <class name="TokenIdentifier" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind
- @return the kind of the token]]>
- </doc>
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Ugi with the username encoded in the token identifier
-
- @return the username. null is returned if username in the identifier is
- empty or null.]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the bytes for the token identifier
- @return the bytes of the identifier]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An identifier that identifies a token, may contain public information
- about a token, including its kind (or type).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.TokenIdentifier -->
- <!-- start interface org.apache.hadoop.security.token.TokenInfo -->
- <interface name="TokenInfo" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.annotation.Annotation"/>
- <method name="value" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The type of TokenSelector to be used]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Indicates Token related information to be used]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.token.TokenInfo -->
- <!-- start class org.apache.hadoop.security.token.TokenRenewer -->
- <class name="TokenRenewer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TokenRenewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="handleKind" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="kind" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[Does this renewer handle this kind of token?
- @param kind the kind of the token
- @return true if this renewer can renew it]]>
- </doc>
- </method>
- <method name="isManaged" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Is the given token managed? Only managed tokens may be renewed or
- cancelled.
- @param token the token being checked
- @return true if the token may be renewed or cancelled
- @throws IOException]]>
- </doc>
- </method>
- <method name="renew" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew the given token.
- @return the new expiration time
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="cancel"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Cancel the given token
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is the interface for plugins that handle tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.TokenRenewer -->
- <!-- start interface org.apache.hadoop.security.token.TokenSelector -->
- <interface name="TokenSelector" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- <doc>
- <![CDATA[Select token of type T from tokens for use with named service
-
- @param <T>
- T extends TokenIdentifier]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.security.token.TokenSelector -->
- </package>
- <package name="org.apache.hadoop.security.token.delegation">
- <!-- start class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier -->
- <class name="AbstractDelegationTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AbstractDelegationTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="AbstractDelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the username encoded in the token identifier
-
- @return the username or owner]]>
- </doc>
- </method>
- <method name="getRenewer" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIssueDate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="issueDate" type="long"/>
- </method>
- <method name="getIssueDate" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setMaxDate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxDate" type="long"/>
- </method>
- <method name="getMaxDate" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setSequenceNumber"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="seqNum" type="int"/>
- </method>
- <method name="getSequenceNumber" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setMasterKeyId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newId" type="int"/>
- </method>
- <method name="getMasterKeyId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier -->
- <!-- start class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager -->
- <class name="AbstractDelegationTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AbstractDelegationTokenSecretManager" type="long, long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="startThreads"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[should be called before this object is used]]>
- </doc>
- </method>
- <method name="isRunning" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[is secretMgr running
- @return true if secret mgr is running]]>
- </doc>
- </method>
- <method name="addKey"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.security.token.delegation.DelegationKey"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a previously used master key to cache (when NN restarts),
- should be called before activate().]]>
- </doc>
- </method>
- <method name="getAllKeys" return="org.apache.hadoop.security.token.delegation.DelegationKey[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="logUpdateMasterKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.security.token.delegation.DelegationKey"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createPassword" return="byte[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier"/>
- </method>
- <method name="retrievePassword" return="byte[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- </method>
- <method name="verifyToken"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier"/>
- <param name="password" type="byte[]"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <doc>
- <![CDATA[Verifies that the given identifier and password are valid and match.
- @param identifier Token identifier.
- @param password Password in the token.
- @throws InvalidToken]]>
- </doc>
- </method>
- <method name="renewToken" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="renewer" type="java.lang.String"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Renew a delegation token.
- @param token the token to renew
- @param renewer the full principal name of the user doing the renewal
- @return the new expiration time
- @throws InvalidToken if the token is invalid
- @throws AccessControlException if the user can't renew token]]>
- </doc>
- </method>
- <method name="cancelToken" return="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="canceller" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Cancel a token by removing it from cache.
- @return Identifier of the canceled token
- @throws InvalidToken for invalid token
- @throws AccessControlException if the user isn't allowed to cancel]]>
- </doc>
- </method>
- <method name="createSecretKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Convert the byte[] to a secret key
- @param key the byte[] to create the secret key from
- @return the secret key]]>
- </doc>
- </method>
- <method name="stopThreads"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="currentTokens" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Cache of currently valid tokens, mapping from DelegationTokenIdentifier
- to DelegationTokenInformation. Protected by this object lock.]]>
- </doc>
- </field>
- <field name="delegationTokenSequenceNumber" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Sequence number to create DelegationTokenIdentifier.
- Protected by this object lock.]]>
- </doc>
- </field>
- <field name="allKeys" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Access to allKeys is protected by this object lock]]>
- </doc>
- </field>
- <field name="currentId" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Access to currentId is protected by this object lock.]]>
- </doc>
- </field>
- <field name="running" type="boolean"
- transient="false" volatile="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="noInterruptsLock" type="java.lang.Object"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the delegation token update thread holds this lock, it will
- not get interrupted.]]>
- </doc>
- </field>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager -->
- <!-- start class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation -->
- <class name="AbstractDelegationTokenSecretManager.DelegationTokenInformation" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AbstractDelegationTokenSecretManager.DelegationTokenInformation" type="long, byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRenewDate" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[returns renew date]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Class to encapsulate a token's renew date and password.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation -->
- <!-- start class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSelector -->
- <class name="AbstractDelegationTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="AbstractDelegationTokenSelector" type="org.apache.hadoop.io.Text"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- <doc>
- <![CDATA[Look through tokens to find the first delegation token that matches the
- service and return it.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSelector -->
- <!-- start class org.apache.hadoop.security.token.delegation.DelegationKey -->
- <class name="DelegationKey" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="DelegationKey"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="DelegationKey" type="int, long, javax.crypto.SecretKey"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKeyId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getExpiryDate" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setExpiryDate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expiryDate" type="long"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Key used for generating and verifying delegation tokens]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.security.token.delegation.DelegationKey -->
- </package>
- <package name="org.apache.hadoop.util">
- <!-- start class org.apache.hadoop.util.ChecksumUtil -->
- <class name="ChecksumUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ChecksumUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="updateChunkChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="checksumOff" type="int"/>
- <param name="dataOff" type="int"/>
- <param name="dataLen" type="int"/>
- <param name="checksum" type="org.apache.hadoop.util.DataChecksum"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[updates the checksum for a buffer
-
- @param buf - buffer to update the checksum in
- @param checksumOff - offset in the buffer where the checksum is to update
- @param dataOff - offset in the buffer of the data
- @param dataLen - length of data to compute checksum on]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.util.ChecksumUtil -->
- <!-- start class org.apache.hadoop.util.ClassUtil -->
- <class name="ClassUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClassUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="findContainingJar" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <doc>
- <![CDATA[Find a jar that contains a class of the same name, if any.
- It will return a jar file, even if that is not the first thing
- on the class path that has a class with the same name.
-
- @param clazz the class to find.
- @return a jar file that contains the class, or null.
- @throws IOException]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.util.ClassUtil -->
- <!-- start class org.apache.hadoop.util.CyclicIteration -->
- <class name="CyclicIteration" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Iterable"/>
- <constructor name="CyclicIteration" type="java.util.NavigableMap, java.lang.Object"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an {@link Iterable} object,
- so that an {@link Iterator} can be created
- for iterating the given {@link NavigableMap}.
- The iteration begins from the starting key exclusively.]]>
- </doc>
- </constructor>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Provide an cyclic {@link Iterator} for a {@link NavigableMap}.
- The {@link Iterator} navigates the entries of the map
- according to the map's ordering.
- If the {@link Iterator} hits the last entry of the map,
- it will then continue from the first entry.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.CyclicIteration -->
- <!-- start class org.apache.hadoop.util.Daemon -->
- <class name="Daemon" extends="java.lang.Thread"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Daemon"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a daemon thread.]]>
- </doc>
- </constructor>
- <constructor name="Daemon" type="java.lang.Runnable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a daemon thread.]]>
- </doc>
- </constructor>
- <constructor name="Daemon" type="java.lang.ThreadGroup, java.lang.Runnable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a daemon thread to be part of a specified thread group.]]>
- </doc>
- </constructor>
- <method name="getRunnable" return="java.lang.Runnable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A thread that has called {@link Thread#setDaemon(boolean) } with true.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Daemon -->
- <!-- start class org.apache.hadoop.util.DataChecksum -->
- <class name="DataChecksum" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.zip.Checksum"/>
- <method name="newDataChecksum" return="org.apache.hadoop.util.DataChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="int"/>
- <param name="bytesPerChecksum" type="int"/>
- </method>
- <method name="newDataChecksum" return="org.apache.hadoop.util.DataChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="offset" type="int"/>
- <doc>
- <![CDATA[Creates a DataChecksum from HEADER_LEN bytes from arr[offset].
- @return DataChecksum of the type in the array or null in case of an error.]]>
- </doc>
- </method>
- <method name="newDataChecksum" return="org.apache.hadoop.util.DataChecksum"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This constructucts a DataChecksum by reading HEADER_LEN bytes from
- input stream <i>in</i>]]>
- </doc>
- </method>
- <method name="writeHeader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes the checksum header to the output stream <i>out</i>.]]>
- </doc>
- </method>
- <method name="getHeader" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="writeValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutputStream"/>
- <param name="reset" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes the current checksum to the stream.
- If <i>reset</i> is true, then resets the checksum.
- @return number of bytes written. Will be equal to getChecksumSize();]]>
- </doc>
- </method>
- <method name="writeValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="reset" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes the current checksum to a buffer.
- If <i>reset</i> is true, then resets the checksum.
- @return number of bytes written. Will be equal to getChecksumSize();]]>
- </doc>
- </method>
- <method name="compare" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buf" type="byte[]"/>
- <param name="offset" type="int"/>
- <doc>
- <![CDATA[Compares the checksum located at buf[offset] with the current checksum.
- @return true if the checksum matches and false otherwise.]]>
- </doc>
- </method>
- <method name="getChecksumType" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getChecksumSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBytesPerChecksum" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumBytesInSum" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getChecksumHeaderSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- </method>
- <field name="HEADER_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CHECKSUM_NULL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CHECKSUM_CRC32" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SIZE_OF_INTEGER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class provides inteface and utilities for processing checksums for
- DFS data transfers.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.DataChecksum -->
- <!-- start class org.apache.hadoop.util.DiskChecker -->
- <class name="DiskChecker" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DiskChecker"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="mkdirsWithExistsCheck" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[The semantics of mkdirsWithExistsCheck method is different from the mkdirs
- method provided in the Sun's java.io.File class in the following way:
- While creating the non-existent parent directories, this method checks for
- the existence of those directories if the mkdir fails at any point (since
- that directory might have just been created by some other process).
- If both mkdir() and the exists() check fails for any seemingly
- non-existent directory, then we signal an error; Sun's mkdir would signal
- an error (return false) if a directory it is attempting to create already
- exists or the mkdir fails.
- @param dir
- @return true on success, false on failure]]>
- </doc>
- </method>
- <method name="checkDir"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <exception name="DiskChecker.DiskErrorException" type="org.apache.hadoop.util.DiskChecker.DiskErrorException"/>
- <doc>
- <![CDATA[Create the directory if it doesn't exist and
- @param dir
- @throws DiskErrorException]]>
- </doc>
- </method>
- <method name="mkdirsWithExistsAndPermissionCheck" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localFS" type="org.apache.hadoop.fs.LocalFileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="expected" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the directory or check permissions if it already exists.
-
- The semantics of mkdirsWithExistsAndPermissionCheck method is different
- from the mkdirs method provided in the Sun's java.io.File class in the
- following way:
- While creating the non-existent parent directories, this method checks for
- the existence of those directories if the mkdir fails at any point (since
- that directory might have just been created by some other process).
- If both mkdir() and the exists() check fails for any seemingly
- non-existent directory, then we signal an error; Sun's mkdir would signal
- an error (return false) if a directory it is attempting to create already
- exists or the mkdir fails.
- @param localFS local filesystem
- @param dir directory to be created or checked
- @param expected expected permission
- @return true on success, false on failure]]>
- </doc>
- </method>
- <method name="checkDir"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localFS" type="org.apache.hadoop.fs.LocalFileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="expected" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="DiskChecker.DiskErrorException" type="org.apache.hadoop.util.DiskChecker.DiskErrorException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the local directory if necessary, check permissions and also ensure
- it can be read from and written into.
- @param localFS local filesystem
- @param dir directory
- @param expected permission
- @throws DiskErrorException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Class that provides utility functions for checking disk problem]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.DiskChecker -->
- <!-- start class org.apache.hadoop.util.DiskChecker.DiskErrorException -->
- <class name="DiskChecker.DiskErrorException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DiskChecker.DiskErrorException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.util.DiskChecker.DiskErrorException -->
- <!-- start class org.apache.hadoop.util.DiskChecker.DiskOutOfSpaceException -->
- <class name="DiskChecker.DiskOutOfSpaceException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DiskChecker.DiskOutOfSpaceException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.util.DiskChecker.DiskOutOfSpaceException -->
- <!-- start class org.apache.hadoop.util.GenericOptionsParser -->
- <class name="GenericOptionsParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GenericOptionsParser" type="org.apache.commons.cli.Options, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an options parser with the given options to parse the args.
- @param opts the options
- @param args the command line arguments
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="GenericOptionsParser" type="java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an options parser to parse the args.
- @param args the command line arguments
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="GenericOptionsParser" type="org.apache.hadoop.conf.Configuration, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a <code>GenericOptionsParser<code> to parse only the generic Hadoop
- arguments.
-
- The array of string arguments other than the generic arguments can be
- obtained by {@link #getRemainingArgs()}.
-
- @param conf the <code>Configuration</code> to modify.
- @param args command-line arguments.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="GenericOptionsParser" type="org.apache.hadoop.conf.Configuration, org.apache.commons.cli.Options, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a <code>GenericOptionsParser</code> to parse given options as well
- as generic Hadoop options.
-
- The resulting <code>CommandLine</code> object can be obtained by
- {@link #getCommandLine()}.
-
- @param conf the configuration to modify
- @param options options built by the caller
- @param args User-specified arguments
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="getRemainingArgs" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an array of Strings containing only application-specific arguments.
-
- @return array of <code>String</code>s containing the un-parsed arguments
- or <strong>empty array</strong> if commandLine was not defined.]]>
- </doc>
- </method>
- <method name="getConfiguration" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the modified configuration
- @return the configuration that has the modified parameters.]]>
- </doc>
- </method>
- <method name="getCommandLine" return="org.apache.commons.cli.CommandLine"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the commons-cli <code>CommandLine</code> object
- to process the parsed arguments.
-
- Note: If the object is created with
- {@link #GenericOptionsParser(Configuration, String[])}, then returned
- object will only contain parsed generic options.
-
- @return <code>CommandLine</code> representing list of arguments
- parsed against Options descriptor.]]>
- </doc>
- </method>
- <method name="getLibJars" return="java.net.URL[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[If libjars are set in the conf, parse the libjars.
- @param conf
- @return libjar urls
- @throws IOException]]>
- </doc>
- </method>
- <method name="printGenericCommandUsage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.PrintStream"/>
- <doc>
- <![CDATA[Print the usage message for generic command-line options supported.
-
- @param out stream to print the usage message to.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>GenericOptionsParser</code> is a utility to parse command line
- arguments generic to the Hadoop framework.
-
- <code>GenericOptionsParser</code> recognizes several standarad command
- line arguments, enabling applications to easily specify a namenode, a
- jobtracker, additional configuration resources etc.
-
- <h4 id="GenericOptions">Generic Options</h4>
-
- <p>The supported generic options are:</p>
- <p><blockquote><pre>
- -conf <configuration file> specify a configuration file
- -D <property=value> use value for given property
- -fs <local|namenode:port> specify a namenode
- -jt <local|jobtracker:port> specify a job tracker
- -files <comma separated list of files> specify comma separated
- files to be copied to the map reduce cluster
- -libjars <comma separated list of jars> specify comma separated
- jar files to include in the classpath.
- -archives <comma separated list of archives> specify comma
- separated archives to be unarchived on the compute machines.
- </pre></blockquote></p>
-
- <p>The general command line syntax is:</p>
- <p><tt><pre>
- bin/hadoop command [genericOptions] [commandOptions]
- </pre></tt></p>
-
- <p>Generic command line arguments <strong>might</strong> modify
- <code>Configuration </code> objects, given to constructors.</p>
-
- <p>The functionality is implemented using Commons CLI.</p>
- <p>Examples:</p>
- <p><blockquote><pre>
- $ bin/hadoop dfs -fs darwin:8020 -ls /data
- list /data directory in dfs with namenode darwin:8020
-
- $ bin/hadoop dfs -D fs.default.name=darwin:8020 -ls /data
- list /data directory in dfs with namenode darwin:8020
-
- $ bin/hadoop dfs -conf hadoop-site.xml -ls /data
- list /data directory in dfs with conf specified in hadoop-site.xml
-
- $ bin/hadoop job -D mapred.job.tracker=darwin:50020 -submit job.xml
- submit a job to job tracker darwin:50020
-
- $ bin/hadoop job -jt darwin:50020 -submit job.xml
- submit a job to job tracker darwin:50020
-
- $ bin/hadoop job -jt local -submit job.xml
- submit a job to local runner
-
- $ bin/hadoop jar -libjars testlib.jar
- -archives test.tgz -files file.txt inputjar args
- job submission with libjars, files and archives
- </pre></blockquote></p>
- @see Tool
- @see ToolRunner]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.GenericOptionsParser -->
- <!-- start class org.apache.hadoop.util.GenericsUtil -->
- <class name="GenericsUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GenericsUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="java.lang.Object"/>
- <doc>
- <![CDATA[Returns the Class object (of type <code>Class<T></code>) of the
- argument of type <code>T</code>.
- @param <T> The type of the argument
- @param t the object to get it class
- @return <code>Class<T></code>]]>
- </doc>
- </method>
- <method name="toArray" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="c" type="java.lang.Class"/>
- <param name="list" type="java.util.List"/>
- <doc>
- <![CDATA[Converts the given <code>List<T></code> to a an array of
- <code>T[]</code>.
- @param c the Class object of the items in the list
- @param list the list to convert]]>
- </doc>
- </method>
- <method name="toArray" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="list" type="java.util.List"/>
- <doc>
- <![CDATA[Converts the given <code>List<T></code> to a an array of
- <code>T[]</code>.
- @param list the list to convert
- @throws ArrayIndexOutOfBoundsException if the list is empty.
- Use {@link #toArray(Class, List)} if the list may be empty.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Contains utility methods for dealing with Java Generics.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.GenericsUtil -->
- <!-- start class org.apache.hadoop.util.HeapSort -->
- <class name="HeapSort" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.IndexedSorter"/>
- <constructor name="HeapSort"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="p" type="int"/>
- <param name="r" type="int"/>
- <doc>
- <![CDATA[Sort the given range of items using heap sort.
- {@inheritDoc}]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="p" type="int"/>
- <param name="r" type="int"/>
- <param name="rep" type="org.apache.hadoop.util.Progressable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An implementation of the core algorithm of HeapSort.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.HeapSort -->
- <!-- start class org.apache.hadoop.util.HostsFileReader -->
- <class name="HostsFileReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HostsFileReader" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="refresh"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getHosts" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getExcludedHosts" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIncludesFile"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includesFile" type="java.lang.String"/>
- </method>
- <method name="setExcludesFile"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="excludesFile" type="java.lang.String"/>
- </method>
- <method name="updateFileNames"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includesFile" type="java.lang.String"/>
- <param name="excludesFile" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.util.HostsFileReader -->
- <!-- start interface org.apache.hadoop.util.IndexedSortable -->
- <interface name="IndexedSortable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="j" type="int"/>
- <doc>
- <![CDATA[Compare items at the given addresses consistent with the semantics of
- {@link java.util.Comparator#compare(Object, Object)}.]]>
- </doc>
- </method>
- <method name="swap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <param name="j" type="int"/>
- <doc>
- <![CDATA[Swap items at the given addresses.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for collections capable of being sorted by {@link IndexedSorter}
- algorithms.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.IndexedSortable -->
- <!-- start interface org.apache.hadoop.util.IndexedSorter -->
- <interface name="IndexedSorter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="l" type="int"/>
- <param name="r" type="int"/>
- <doc>
- <![CDATA[Sort the items accessed through the given IndexedSortable over the given
- range of logical indices. From the perspective of the sort algorithm,
- each index between l (inclusive) and r (exclusive) is an addressable
- entry.
- @see IndexedSortable#compare
- @see IndexedSortable#swap]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="l" type="int"/>
- <param name="r" type="int"/>
- <param name="rep" type="org.apache.hadoop.util.Progressable"/>
- <doc>
- <![CDATA[Same as {@link #sort(IndexedSortable,int,int)}, but indicate progress
- periodically.
- @see #sort(IndexedSortable,int,int)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface for sort algorithms accepting {@link IndexedSortable} items.
- A sort algorithm implementing this interface may only
- {@link IndexedSortable#compare} and {@link IndexedSortable#swap} items
- for a range of indices to effect a sort across that range.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.IndexedSorter -->
- <!-- start class org.apache.hadoop.util.LineReader -->
- <class name="LineReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LineReader" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- default buffer-size (64k).
- @param in The input stream
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="LineReader" type="java.io.InputStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- given buffer-size.
- @param in The input stream
- @param bufferSize Size of the read buffer
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="LineReader" type="java.io.InputStream, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- <code>io.file.buffer.size</code> specified in the given
- <code>Configuration</code>.
- @param in input stream
- @param conf configuration
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="LineReader" type="java.io.InputStream, byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- default buffer-size, and using a custom delimiter of array of
- bytes.
- @param in The input stream
- @param recordDelimiterBytes The delimiter]]>
- </doc>
- </constructor>
- <constructor name="LineReader" type="java.io.InputStream, int, byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- given buffer-size, and using a custom delimiter of array of
- bytes.
- @param in The input stream
- @param bufferSize Size of the read buffer
- @param recordDelimiterBytes The delimiter
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="LineReader" type="java.io.InputStream, org.apache.hadoop.conf.Configuration, byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a line reader that reads from the given stream using the
- <code>io.file.buffer.size</code> specified in the given
- <code>Configuration</code>, and using a custom delimiter of array of
- bytes.
- @param in input stream
- @param conf configuration
- @param recordDelimiterBytes The delimiter
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the underlying stream.
- @throws IOException]]>
- </doc>
- </method>
- <method name="readLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="org.apache.hadoop.io.Text"/>
- <param name="maxLineLength" type="int"/>
- <param name="maxBytesToConsume" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read one line from the InputStream into the given Text.
- @param str the object to store the given line (without newline)
- @param maxLineLength the maximum number of bytes to store into str;
- the rest of the line is silently discarded.
- @param maxBytesToConsume the maximum number of bytes to consume
- in this call. This is only a hint, because if the line cross
- this threshold, we allow it to happen. It can overshoot
- potentially by as much as one buffer length.
- @return the number of bytes read including the (longest) newline
- found.
- @throws IOException if the underlying stream throws]]>
- </doc>
- </method>
- <method name="readLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="org.apache.hadoop.io.Text"/>
- <param name="maxLineLength" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read from the InputStream into the given Text.
- @param str the object to store the given line
- @param maxLineLength the maximum number of bytes to store into str.
- @return the number of bytes read including the newline
- @throws IOException if the underlying stream throws]]>
- </doc>
- </method>
- <method name="readLine" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read from the InputStream into the given Text.
- @param str the object to store the given line
- @return the number of bytes read including the newline
- @throws IOException if the underlying stream throws]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that provides a line reader from an input stream.
- Depending on the constructor used, lines will either be terminated by:
- <ul>
- <li>one of the following: '\n' (LF) , '\r' (CR),
- or '\r\n' (CR+LF).</li>
- <li><em>or</em>, a custom byte sequence delimiter</li>
- </ul>
- In both cases, EOF also terminates an otherwise unterminated
- line.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.LineReader -->
- <!-- start class org.apache.hadoop.util.LinuxMemoryCalculatorPlugin -->
- <class name="LinuxMemoryCalculatorPlugin" extends="org.apache.hadoop.util.MemoryCalculatorPlugin"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.util.LinuxResourceCalculatorPlugin}
- instead">
- <constructor name="LinuxMemoryCalculatorPlugin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPhysicalMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Plugin to calculate virtual and physical memories on Linux systems.
- @deprecated Use {@link org.apache.hadoop.util.LinuxResourceCalculatorPlugin}
- instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.LinuxMemoryCalculatorPlugin -->
- <!-- start class org.apache.hadoop.util.LinuxResourceCalculatorPlugin -->
- <class name="LinuxResourceCalculatorPlugin" extends="org.apache.hadoop.util.ResourceCalculatorPlugin"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LinuxResourceCalculatorPlugin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LinuxResourceCalculatorPlugin" type="java.lang.String, java.lang.String, java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor which allows assigning the /proc/ directories. This will be
- used only in unit tests
- @param procfsMemFile fake file for /proc/meminfo
- @param procfsCpuFile fake file for /proc/cpuinfo
- @param procfsStatFile fake file for /proc/stat
- @param jiffyLengthInMillis fake jiffy length value]]>
- </doc>
- </constructor>
- <method name="getPhysicalMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getAvailablePhysicalMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getAvailableVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getNumProcessors" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCpuFrequency" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCpuUsage" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Test the {@link LinuxResourceCalculatorPlugin}
- @param args]]>
- </doc>
- </method>
- <method name="getProcResourceValues" return="org.apache.hadoop.util.ResourceCalculatorPlugin.ProcResourceValues"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Plugin to calculate resource information on Linux systems.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.LinuxResourceCalculatorPlugin -->
- <!-- start class org.apache.hadoop.util.MemoryCalculatorPlugin -->
- <class name="MemoryCalculatorPlugin" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Use
- {@link org.apache.hadoop.util.ResourceCalculatorPlugin}
- instead">
- <constructor name="MemoryCalculatorPlugin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getVirtualMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the virtual memory present in the system.
-
- @return virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getPhysicalMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the physical memory present in the system.
-
- @return physical memory size bytes.]]>
- </doc>
- </method>
- <method name="getMemoryCalculatorPlugin" return="org.apache.hadoop.util.MemoryCalculatorPlugin"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the MemoryCalculatorPlugin from the class name and configure it. If
- class name is null, this method will try and return a memory calculator
- plugin available for this system.
-
- @param clazz class-name
- @param conf configure the plugin with this.
- @return MemoryCalculatorPlugin]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Plugin to calculate virtual and physical memories on the system.
-
- @deprecated Use
- {@link org.apache.hadoop.util.ResourceCalculatorPlugin}
- instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.MemoryCalculatorPlugin -->
- <!-- start class org.apache.hadoop.util.MergeSort -->
- <class name="MergeSort" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MergeSort" type="java.util.Comparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="mergeSort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="src" type="int[]"/>
- <param name="dest" type="int[]"/>
- <param name="low" type="int"/>
- <param name="high" type="int"/>
- </method>
- <doc>
- <![CDATA[An implementation of the core algorithm of MergeSort.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.MergeSort -->
- <!-- start class org.apache.hadoop.util.NativeCodeLoader -->
- <class name="NativeCodeLoader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NativeCodeLoader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isNativeCodeLoaded" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check if native-hadoop code is loaded for this platform.
-
- @return <code>true</code> if native-hadoop is loaded,
- else <code>false</code>]]>
- </doc>
- </method>
- <method name="getLoadNativeLibraries" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Return if native hadoop libraries, if present, can be used for this job.
- @param conf configuration
-
- @return <code>true</code> if native hadoop libraries, if present, can be
- used for this job; <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setLoadNativeLibraries"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="loadNativeLibraries" type="boolean"/>
- <doc>
- <![CDATA[Set if native hadoop libraries, if present, can be used for this job.
-
- @param conf configuration
- @param loadNativeLibraries can native hadoop libraries be loaded]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A helper to load the native hadoop code i.e. libhadoop.so.
- This handles the fallback to either the bundled libhadoop-Linux-i386-32.so
- or the default java implementations where appropriate.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.NativeCodeLoader -->
- <!-- start class org.apache.hadoop.util.PlatformName -->
- <class name="PlatformName" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PlatformName"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPlatformName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the complete platform as per the java-vm.
- @return returns the complete platform as per the java-vm.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <doc>
- <![CDATA[A helper class for getting build-info of the java-vm.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PlatformName -->
- <!-- start class org.apache.hadoop.util.PrintJarMainClass -->
- <class name="PrintJarMainClass" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PrintJarMainClass"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[@param args]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A micro-application that prints the main class name out of a jar file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PrintJarMainClass -->
- <!-- start class org.apache.hadoop.util.PriorityQueue -->
- <class name="PriorityQueue" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PriorityQueue"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="lessThan" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="a" type="java.lang.Object"/>
- <param name="b" type="java.lang.Object"/>
- <doc>
- <![CDATA[Determines the ordering of objects in this priority queue. Subclasses
- must define this one method.]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="maxSize" type="int"/>
- <doc>
- <![CDATA[Subclass constructors must call this.]]>
- </doc>
- </method>
- <method name="put"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="element" type="java.lang.Object"/>
- <doc>
- <![CDATA[Adds an Object to a PriorityQueue in log(size) time.
- If one tries to add more objects than maxSize from initialize
- a RuntimeException (ArrayIndexOutOfBound) is thrown.]]>
- </doc>
- </method>
- <method name="insert" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="element" type="java.lang.Object"/>
- <doc>
- <![CDATA[Adds element to the PriorityQueue in log(size) time if either
- the PriorityQueue is not full, or not lessThan(element, top()).
- @param element
- @return true if element is added, false otherwise.]]>
- </doc>
- </method>
- <method name="top" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the least element of the PriorityQueue in constant time.]]>
- </doc>
- </method>
- <method name="pop" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Removes and returns the least element of the PriorityQueue in log(size)
- time.]]>
- </doc>
- </method>
- <method name="adjustTop"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should be called when the Object at top changes values. Still log(n)
- worst case, but it's at least twice as fast to <pre>
- { pq.top().change(); pq.adjustTop(); }
- </pre> instead of <pre>
- { o = pq.pop(); o.change(); pq.push(o); }
- </pre>]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of elements currently stored in the PriorityQueue.]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Removes all entries from the PriorityQueue.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A PriorityQueue maintains a partial ordering of its elements such that the
- least element can always be found in constant time. Put()'s and pop()'s
- require log(size) time.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PriorityQueue -->
- <!-- start class org.apache.hadoop.util.ProcessTree -->
- <class name="ProcessTree" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ProcessTree"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="killProcess"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pid" type="java.lang.String"/>
- <param name="signal" type="org.apache.hadoop.util.ProcessTree.Signal"/>
- <doc>
- <![CDATA[Sends signal to process, forcefully terminating the process.
-
- @param pid process id
- @param signal the signal number to send]]>
- </doc>
- </method>
- <method name="killProcessGroup"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pgrpId" type="java.lang.String"/>
- <param name="signal" type="org.apache.hadoop.util.ProcessTree.Signal"/>
- <doc>
- <![CDATA[Sends signal to all process belonging to same process group,
- forcefully terminating the process group.
-
- @param pgrpId process group id
- @param signal the signal number to send]]>
- </doc>
- </method>
- <method name="isAlive" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pid" type="java.lang.String"/>
- <doc>
- <![CDATA[Is the process with PID pid still alive?
- This method assumes that isAlive is called on a pid that was alive not
- too long ago, and hence assumes no chance of pid-wrapping-around.
-
- @param pid pid of the process to check.
- @return true if process is alive.]]>
- </doc>
- </method>
- <method name="isProcessGroupAlive" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pgrpId" type="java.lang.String"/>
- <doc>
- <![CDATA[Is the process group with still alive?
-
- This method assumes that isAlive is called on a pid that was alive not
- too long ago, and hence assumes no chance of pid-wrapping-around.
-
- @param pgrpId process group id
- @return true if any of process in group is alive.]]>
- </doc>
- </method>
- <field name="isSetsidAvailable" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Process tree related operations]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ProcessTree -->
- <!-- start class org.apache.hadoop.util.ProcessTree.Signal -->
- <class name="ProcessTree.Signal" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.util.ProcessTree.Signal[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.util.ProcessTree.Signal"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="QUIT" type="org.apache.hadoop.util.ProcessTree.Signal"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILL" type="org.apache.hadoop.util.ProcessTree.Signal"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TERM" type="org.apache.hadoop.util.ProcessTree.Signal"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The constants for the signals.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ProcessTree.Signal -->
- <!-- start class org.apache.hadoop.util.ProcfsBasedProcessTree -->
- <class name="ProcfsBasedProcessTree" extends="org.apache.hadoop.util.ProcessTree"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ProcfsBasedProcessTree" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ProcfsBasedProcessTree" type="java.lang.String, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ProcfsBasedProcessTree" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isAvailable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Checks if the ProcfsBasedProcessTree is available on this system.
-
- @return true if ProcfsBasedProcessTree is available. False otherwise.]]>
- </doc>
- </method>
- <method name="getProcessTree" return="org.apache.hadoop.util.ProcfsBasedProcessTree"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the process-tree with latest state. If the root-process is not alive,
- an empty tree will be returned.
-
- @return the process-tree with latest state.]]>
- </doc>
- </method>
- <method name="isAlive" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is the root-process alive?
-
- @return true if the root-process is alive, false otherwise.]]>
- </doc>
- </method>
- <method name="isAnyProcessInTreeAlive" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is any of the subprocesses in the process-tree alive?
-
- @return true if any of the processes in the process-tree is
- alive, false otherwise.]]>
- </doc>
- </method>
- <method name="getProcessTreeDump" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a dump of the process-tree.
-
- @return a string concatenating the dump of information of all the processes
- in the process-tree]]>
- </doc>
- </method>
- <method name="getCumulativeVmem" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the cumulative virtual memory used by all the processes in the
- process-tree.
-
- @return cumulative virtual memory used by the process-tree in bytes.]]>
- </doc>
- </method>
- <method name="getCumulativeRssmem" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the cumulative resident set size (rss) memory used by all the processes
- in the process-tree.
- @return cumulative rss memory used by the process-tree in bytes. return 0
- if it cannot be calculated]]>
- </doc>
- </method>
- <method name="getCumulativeVmem" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="olderThanAge" type="int"/>
- <doc>
- <![CDATA[Get the cumulative virtual memory used by all the processes in the
- process-tree that are older than the passed in age.
-
- @param olderThanAge processes above this age are included in the
- memory addition
- @return cumulative virtual memory used by the process-tree in bytes,
- for processes older than this age.]]>
- </doc>
- </method>
- <method name="getCumulativeRssmem" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="olderThanAge" type="int"/>
- <doc>
- <![CDATA[Get the cumulative resident set size (rss) memory used by all the processes
- in the process-tree that are older than the passed in age.
- @param olderThanAge processes above this age are included in the
- memory addition
- @return cumulative rss memory used by the process-tree in bytes,
- for processes older than this age. return 0 if it cannot be
- calculated]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the CPU time in millisecond used by all the processes in the
- process-tree since the process-tree created
- @return cumulative CPU time in millisecond since the process-tree created
- return 0 if it cannot be calculated]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a string printing PIDs of process present in the
- ProcfsBasedProcessTree. Output format : [pid pid ..]]]>
- </doc>
- </method>
- <field name="PAGE_SIZE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JIFFY_LENGTH_IN_MILLIS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Proc file-system based ProcessTree. Works only on Linux.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ProcfsBasedProcessTree -->
- <!-- start class org.apache.hadoop.util.ProgramDriver -->
- <class name="ProgramDriver" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ProgramDriver"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="mainClass" type="java.lang.Class"/>
- <param name="description" type="java.lang.String"/>
- <exception name="Throwable" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[This is the method that adds the classed to the repository
- @param name The name of the string you want the class instance to be called with
- @param mainClass The class that you want to add to the repository
- @param description The description of the class
- @throws NoSuchMethodException
- @throws SecurityException]]>
- </doc>
- </method>
- <method name="driver"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Throwable" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[This is a driver for the example programs.
- It looks at the first command line argument and tries to find an
- example program with that name.
- If it is found, it calls the main method in that class with the rest
- of the command line arguments.
- @param args The argument from the user. args[0] is the command to run.
- @throws NoSuchMethodException
- @throws SecurityException
- @throws IllegalAccessException
- @throws IllegalArgumentException
- @throws Throwable Anything thrown by the example program's main]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A driver that is used to run programs added to it]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ProgramDriver -->
- <!-- start class org.apache.hadoop.util.Progress -->
- <class name="Progress" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Progress"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates a new root node.]]>
- </doc>
- </constructor>
- <method name="addPhase" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- <doc>
- <![CDATA[Adds a named node to the tree.]]>
- </doc>
- </method>
- <method name="addPhase" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Adds a node to the tree.]]>
- </doc>
- </method>
- <method name="startNextPhase"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called during execution to move to the next phase at this level in the
- tree.]]>
- </doc>
- </method>
- <method name="phase" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the current sub-node executing.]]>
- </doc>
- </method>
- <method name="complete"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Completes this node, moving the parent node to its next child.]]>
- </doc>
- </method>
- <method name="set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- <doc>
- <![CDATA[Called during execution on a leaf node to set its progress.]]>
- </doc>
- </method>
- <method name="get" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the overall progress of the root.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns progress in this node. get() would give overall progress of the
- root node(not just given current node).]]>
- </doc>
- </method>
- <method name="setStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Utility to assist with generation of progress reports. Applications build
- a hierarchy of {@link Progress} instances, each modelling a phase of
- execution. The root is constructed with {@link #Progress()}. Nodes for
- sub-phases are created by calling {@link #addPhase()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Progress -->
- <!-- start interface org.apache.hadoop.util.Progressable -->
- <interface name="Progressable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Report progress to the Hadoop framework.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A facility for reporting progress.
-
- <p>Clients and/or applications can use the provided <code>Progressable</code>
- to explicitly report progress to the Hadoop framework. This is especially
- important for operations which take an insignificant amount of time since,
- in-lieu of the reported progress, the framework has to assume that an error
- has occured and time-out the operation.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.Progressable -->
- <!-- start class org.apache.hadoop.util.PureJavaCrc32 -->
- <class name="PureJavaCrc32" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.zip.Checksum"/>
- <constructor name="PureJavaCrc32"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="update"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="int"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A pure-java implementation of the CRC32 checksum that uses
- the same polynomial as the built-in native CRC32.
- This is to avoid the JNI overhead for certain uses of Checksumming
- where many small pieces of data are checksummed in succession.
- The current version is ~10x to 1.8x as fast as Sun's native
- java.util.zip.CRC32 in Java 1.6
- @see java.util.zip.CRC32]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.PureJavaCrc32 -->
- <!-- start class org.apache.hadoop.util.QueueProcessingStatistics -->
- <class name="QueueProcessingStatistics" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueProcessingStatistics" type="java.lang.String, java.lang.String, org.apache.commons.logging.Log"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param queueName - Human-readable name of the queue being monitored,
- used as first word in the log messages.
- @param workItemsName - what kind of work items are being managed
- on the queue? A plural word is best here, for logging.
- @param logObject - What log do you want the log messages to be sent to?]]>
- </doc>
- </constructor>
- <method name="startCycle"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxWorkToProcess" type="int"/>
- </method>
- <method name="endCycle"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="workFound" type="int"/>
- </method>
- <method name="checkRestart"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="preCheckIsLastCycle" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxWorkToProcess" type="int"/>
- <doc>
- <![CDATA[The termination condition is to identify the last cycle that will
- empty the queue. Two abstract APIs are called: {@code preCheckIsLastCycle}
- is called at the beginning of each cycle, and
- {@link #postCheckIsLastCycle} is called at the end of each cycle.
- At least one of them must correctly provide the termination
- condition. The other may always return 'false'. If either of them
- returns 'true' in a given cycle, then at the end of that cycle the
- stats will be output to log, and stats collection will end.
-
- @param maxWorkToProcess - if this number is greater than the amount
- of work remaining at the start of a cycle, then it will
- be the last cycle.
- @return - true if last cycle detected, else false]]>
- </doc>
- </method>
- <method name="postCheckIsLastCycle" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="workFound" type="int"/>
- <doc>
- <![CDATA[See {@link #preCheckIsLastCycle}.
- @param workFound - may not be useful
- @return - true if remaining work is zero at end of cycle,
- else false]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Hadoop has several work queues, such as
- {@link org.apache.hadoop.hdfs.server.namenode.FSNamesystem#neededReplications}
- With a properly throttled queue, a worker thread cycles repeatedly,
- doing a chunk of work each cycle then resting a bit, until the queue is
- empty. This class is intended to collect statistics about the behavior of
- such queues and consumers. It reports the amount of work done and
- how long it took, for the first cycle after collection starts, and for
- the total number of cycles needed to flush the queue. We use a state
- machine to detect when the queue has been flushed and then we log the
- stats; see {@link State} for enumeration of the states and their meanings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.QueueProcessingStatistics -->
- <!-- start class org.apache.hadoop.util.QueueProcessingStatistics.State -->
- <class name="QueueProcessingStatistics.State" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.util.QueueProcessingStatistics.State[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.util.QueueProcessingStatistics.State"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="BEGIN_COLLECTING" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_FIRST_CYCLE" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_SOLE_CYCLE" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DONE_FIRST_CYCLE" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_LAST_CYCLE" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DONE_COLLECTING" type="org.apache.hadoop.util.QueueProcessingStatistics.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This enum provides the "states" of a state machine for
- {@link QueueProcessingStatistics}.
- The meanings of the states are: <ul>
- <li> BEGIN_COLLECTING - Ready to begin.
- <li> IN_FIRST_CYCLE - Started the first cycle.
- <li> IN_SOLE_CYCLE - Still in first cycle, but already know there will be
- no further cycles because this one will complete all
- needed work. When done, will go straight to
- "DONE_COLLECTING".
- <li> DONE_FIRST_CYCLE - Done first cycle, doing subsequent cycles.
- <li> IN_LAST_CYCLE - Started the last cycle.
- <li> DONE_COLLECTING - Done with last cycle, finishing up.
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.QueueProcessingStatistics.State -->
- <!-- start class org.apache.hadoop.util.QuickSort -->
- <class name="QuickSort" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.IndexedSorter"/>
- <constructor name="QuickSort"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMaxDepth" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="x" type="int"/>
- <doc>
- <![CDATA[Deepest recursion before giving up and doing a heapsort.
- Returns 2 * ceil(log(n)).]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="p" type="int"/>
- <param name="r" type="int"/>
- <doc>
- <![CDATA[Sort the given range of items using quick sort.
- {@inheritDoc} If the recursion depth falls below {@link #getMaxDepth},
- then switch to {@link HeapSort}.]]>
- </doc>
- </method>
- <method name="sort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.util.IndexedSortable"/>
- <param name="p" type="int"/>
- <param name="r" type="int"/>
- <param name="rep" type="org.apache.hadoop.util.Progressable"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An implementation of the core algorithm of QuickSort.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.QuickSort -->
- <!-- start class org.apache.hadoop.util.ReflectionUtils -->
- <class name="ReflectionUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReflectionUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theObject" type="java.lang.Object"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Check and set 'configuration' if necessary.
-
- @param theObject object for which to set configuration
- @param conf Configuration]]>
- </doc>
- </method>
- <method name="newInstance" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Create an object for the given class and initialize it from conf
-
- @param theClass class of which an object is created
- @param conf Configuration
- @return a new object]]>
- </doc>
- </method>
- <method name="setContentionTracing"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="boolean"/>
- </method>
- <method name="printThreadInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stream" type="java.io.PrintWriter"/>
- <param name="title" type="java.lang.String"/>
- <doc>
- <![CDATA[Print all of the thread's information and stack traces.
-
- @param stream the stream to
- @param title a string title for the stack trace]]>
- </doc>
- </method>
- <method name="logThreadInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <param name="title" type="java.lang.String"/>
- <param name="minInterval" type="long"/>
- <doc>
- <![CDATA[Log the current thread stacks at INFO level.
- @param log the logger that logs the stack trace
- @param title a descriptive title for the call stacks
- @param minInterval the minimum time from the last]]>
- </doc>
- </method>
- <method name="getClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return the correctly-typed {@link Class} of the given object.
-
- @param o object whose correctly-typed <code>Class</code> is to be obtained
- @return the correctly typed <code>Class</code> of the given object.]]>
- </doc>
- </method>
- <method name="copy" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="src" type="java.lang.Object"/>
- <param name="dst" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Make a copy of the writable object using serialization to a buffer
- @param dst the object to copy from
- @param src the object to copy into, which is destroyed
- @throws IOException]]>
- </doc>
- </method>
- <method name="cloneWritableInto"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dst" type="org.apache.hadoop.io.Writable"/>
- <param name="src" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[General reflection utils]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ReflectionUtils -->
- <!-- start class org.apache.hadoop.util.ResourceCalculatorPlugin -->
- <class name="ResourceCalculatorPlugin" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceCalculatorPlugin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getVirtualMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the virtual memory present in the system.
-
- @return virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getPhysicalMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the physical memory present in the system.
-
- @return physical memory size bytes.]]>
- </doc>
- </method>
- <method name="getAvailableVirtualMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the available virtual memory present
- in the system.
- @return available virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getAvailablePhysicalMemorySize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total size of the available physical memory present
- in the system.
- @return available physical memory size bytes.]]>
- </doc>
- </method>
- <method name="getNumProcessors" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the total number of processors present on the system.
- @return number of processors]]>
- </doc>
- </method>
- <method name="getCpuFrequency" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the CPU frequency of on the system.
- @return CPU frequency in kHz]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the cumulative CPU time since the system is on.
- @return cumulative CPU time in milliseconds]]>
- </doc>
- </method>
- <method name="getCpuUsage" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the CPU usage % of the machine. Return -1 if it is unavailable
- @return CPU usage in %]]>
- </doc>
- </method>
- <method name="getProcResourceValues" return="org.apache.hadoop.util.ResourceCalculatorPlugin.ProcResourceValues"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain resource status used by current process tree.]]>
- </doc>
- </method>
- <method name="getResourceCalculatorPlugin" return="org.apache.hadoop.util.ResourceCalculatorPlugin"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the ResourceCalculatorPlugin from the class name and configure it. If
- class name is null, this method will try and return a memory calculator
- plugin available for this system.
-
- @param clazz class-name
- @param conf configure the plugin with this.
- @return ResourceCalculatorPlugin]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Plugin to calculate resource information on the system.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ResourceCalculatorPlugin -->
- <!-- start class org.apache.hadoop.util.ResourceCalculatorPlugin.ProcResourceValues -->
- <class name="ResourceCalculatorPlugin.ProcResourceValues" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceCalculatorPlugin.ProcResourceValues" type="long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPhysicalMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the physical memory size used by current process tree.
- @return physical memory size in bytes.]]>
- </doc>
- </method>
- <method name="getVirtualMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the virtual memory size used by a current process tree.
- @return virtual memory size in bytes.]]>
- </doc>
- </method>
- <method name="getCumulativeCpuTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain the cumulative CPU time used by a current process tree.
- @return cumulative CPU time in milliseconds]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.util.ResourceCalculatorPlugin.ProcResourceValues -->
- <!-- start class org.apache.hadoop.util.RunJar -->
- <class name="RunJar" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RunJar"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="unJar"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jarFile" type="java.io.File"/>
- <param name="toDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Unpack a jar file into a directory.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Throwable" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Run a Hadoop job jar. If the main class is not in the jar's manifest,
- then it must be provided on the command line.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Run a Hadoop job jar.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.RunJar -->
- <!-- start interface org.apache.hadoop.util.ServicePlugin -->
- <interface name="ServicePlugin" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="java.lang.Object"/>
- <doc>
- <![CDATA[This method is invoked when the service instance has been started.
- @param service The service instance invoking this method]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method is invoked when the service instance is about to be shut down.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Service plug-in interface.
- Service plug-ins may be used to expose functionality of datanodes or
- namenodes using arbitrary RPC protocols. Plug-ins are instantiated by the
- service instance, and are notified of service life-cycle events using the
- methods defined by this class.
- Service plug-ins are started after the service instance is started, and
- stopped before the service instance is stopped.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.ServicePlugin -->
- <!-- start class org.apache.hadoop.util.ServletUtil -->
- <class name="ServletUtil" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ServletUtil"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initHTML" return="java.io.PrintWriter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="response" type="javax.servlet.ServletResponse"/>
- <param name="title" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initial HTML header]]>
- </doc>
- </method>
- <method name="getParameter" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.ServletRequest"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get a parameter from a ServletRequest.
- Return null if the parameter contains only white spaces.]]>
- </doc>
- </method>
- <method name="htmlFooter" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HTML footer to be added in the jsps.
- @return the HTML footer.]]>
- </doc>
- </method>
- <method name="percentageGraph" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="perc" type="int"/>
- <param name="width" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Generate the percentage graph and returns HTML representation string
- of the same.
-
- @param perc The percentage value for which graph is to be generated
- @param width The width of the display table
- @return HTML String representation of the percentage graph
- @throws IOException]]>
- </doc>
- </method>
- <method name="percentageGraph" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="perc" type="float"/>
- <param name="width" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Generate the percentage graph and returns HTML representation string
- of the same.
- @param perc The percentage value for which graph is to be generated
- @param width The width of the display table
- @return HTML String representation of the percentage graph
- @throws IOException]]>
- </doc>
- </method>
- <field name="HTML_TAIL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.util.ServletUtil -->
- <!-- start class org.apache.hadoop.util.Shell -->
- <class name="Shell" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Shell"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Shell" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param interval the minimum duration to wait before re-executing the
- command.]]>
- </doc>
- </constructor>
- <method name="getGroupsCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get the current user's groups list]]>
- </doc>
- </method>
- <method name="getGroupsForUserCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[a Unix command to get a given user's groups list]]>
- </doc>
- </method>
- <method name="getUsersForNetgroupCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="netgroup" type="java.lang.String"/>
- <doc>
- <![CDATA[a Unix command to get a given netgroup's user list]]>
- </doc>
- </method>
- <method name="getGET_PERMISSION_COMMAND" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return a Unix command to get permission information.]]>
- </doc>
- </method>
- <method name="getUlimitMemoryCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memoryLimit" type="int"/>
- <doc>
- <![CDATA[Get the Unix command for setting the maximum virtual memory available
- to a given child process. This is only relevant when we are forking a
- process from within the Mapper or the Reducer implementations.
- Also see Hadoop Pipes and Hadoop Streaming.
-
- It also checks to ensure that we are running on a *nix platform else
- (e.g. in Cygwin/Windows) it returns <code>null</code>.
- @param memoryLimit virtual memory limit
- @return a <code>String[]</code> with the ulimit command arguments or
- <code>null</code> if we are running on a non *nix platform or
- if the limit is unspecified.]]>
- </doc>
- </method>
- <method name="getUlimitMemoryCommand" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #getUlimitMemoryCommand(int)}">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the Unix command for setting the maximum virtual memory available
- to a given child process. This is only relevant when we are forking a
- process from within the {@link org.apache.hadoop.mapred.Mapper} or the
- {@link org.apache.hadoop.mapred.Reducer} implementations
- e.g. <a href="{@docRoot}/org/apache/hadoop/mapred/pipes/package-summary.html">Hadoop Pipes</a>
- or <a href="{@docRoot}/org/apache/hadoop/streaming/package-summary.html">Hadoop Streaming</a>.
-
- It also checks to ensure that we are running on a *nix platform else
- (e.g. in Cygwin/Windows) it returns <code>null</code>.
- @param conf configuration
- @return a <code>String[]</code> with the ulimit command arguments or
- <code>null</code> if we are running on a non *nix platform or
- if the limit is unspecified.
- @deprecated Use {@link #getUlimitMemoryCommand(int)}]]>
- </doc>
- </method>
- <method name="setEnvironment"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <doc>
- <![CDATA[set the environment for the command
- @param env Mapping of environment variables]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="dir" type="java.io.File"/>
- <doc>
- <![CDATA[set the working directory
- @param dir The directory where the command would be executed]]>
- </doc>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[check to see if a command needs to be executed and execute if needed]]>
- </doc>
- </method>
- <method name="getExecString" return="java.lang.String[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[return an array containing the command name & its parameters]]>
- </doc>
- </method>
- <method name="parseExecResult"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="lines" type="java.io.BufferedReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parse the execution result]]>
- </doc>
- </method>
- <method name="getProcess" return="java.lang.Process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the current sub-process executing the given command
- @return process executing the command]]>
- </doc>
- </method>
- <method name="getExitCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get the exit code
- @return the exit code of the process]]>
- </doc>
- </method>
- <method name="isTimedOut" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[To check if the passed script to shell command executor timed out or
- not.
-
- @return if the script timed out.]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param cmd shell command to execute.
- @return the output of the executed command.]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <param name="cmd" type="java.lang.String[]"/>
- <param name="timeout" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param env the map of environment key=value
- @param cmd shell command to execute.
- @param timeout time in milliseconds after which script should be marked timeout
- @return the output of the executed command.o]]>
- </doc>
- </method>
- <method name="execCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="env" type="java.util.Map"/>
- <param name="cmd" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Static method to execute a shell command.
- Covers most of the simple cases without requiring the user to implement
- the <code>Shell</code> interface.
- @param env the map of environment key=value
- @param cmd shell command to execute.
- @return the output of the executed command.]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USER_NAME_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get the current user's name]]>
- </doc>
- </field>
- <field name="SET_PERMISSION_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to set permission]]>
- </doc>
- </field>
- <field name="SET_OWNER_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to set owner]]>
- </doc>
- </field>
- <field name="SET_GROUP_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="timeOutInterval" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time after which the executing script would be timedout]]>
- </doc>
- </field>
- <field name="ULIMIT_COMMAND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[a Unix command to get ulimit of a process.]]>
- </doc>
- </field>
- <field name="WINDOWS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set to true on Windows platforms]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A base class for running a Unix command.
-
- <code>Shell</code> can be used to run unix commands like <code>du</code> or
- <code>df</code>. It also offers facilities to gate commands by
- time-intervals.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Shell -->
- <!-- start class org.apache.hadoop.util.Shell.ExitCodeException -->
- <class name="Shell.ExitCodeException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Shell.ExitCodeException" type="int, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getExitCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This is an IOException with exit code added.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Shell.ExitCodeException -->
- <!-- start class org.apache.hadoop.util.Shell.ShellCommandExecutor -->
- <class name="Shell.ShellCommandExecutor" extends="org.apache.hadoop.util.Shell"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Shell.ShellCommandExecutor" type="java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File, java.util.Map"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File, java.util.Map, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new instance of the ShellCommandExecutor to execute a command.
-
- @param execString The command to execute with arguments
- @param dir If not-null, specifies the directory which should be set
- as the current working directory for the command.
- If null, the current working directory is not modified.
- @param env If not-null, environment of the command will include the
- key-value pairs specified in the map. If null, the current
- environment is not modified.
- @param timeout Specifies the time in milliseconds, after which the
- command will be killed and the status marked as timedout.
- If 0, the command will not be timed out.]]>
- </doc>
- </constructor>
- <method name="execute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Execute the shell command.]]>
- </doc>
- </method>
- <method name="getExecString" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="parseExecResult"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="lines" type="java.io.BufferedReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getOutput" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the output of the shell command.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the commands of this instance.
- Arguments with spaces in are presented with quotes round; other
- arguments are presented raw
- @return a string representation of the object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A simple shell command executor.
-
- <code>ShellCommandExecutor</code>should be used in cases where the output
- of the command needs no explicit parsing and where the command, working
- directory and the environment remains unchanged. The output of the command
- is stored as-is and is expected to be small.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.Shell.ShellCommandExecutor -->
- <!-- start class org.apache.hadoop.util.StringUtils -->
- <class name="StringUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StringUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="stringifyException" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="e" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Make a string representation of the exception.
- @param e The exception to stringify
- @return A string with exception name and call stack.]]>
- </doc>
- </method>
- <method name="simpleHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fullHostname" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a full hostname, return the word upto the first dot.
- @param fullHostname the full hostname
- @return the hostname to the first dot]]>
- </doc>
- </method>
- <method name="humanReadableInt" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="number" type="long"/>
- <doc>
- <![CDATA[Given an integer, return a string that is in an approximate, but human
- readable format.
- It uses the bases 'k', 'm', and 'g' for 1024, 1024**2, and 1024**3.
- @param number the number to format
- @return a human readable form of the integer]]>
- </doc>
- </method>
- <method name="formatPercent" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="done" type="double"/>
- <param name="digits" type="int"/>
- <doc>
- <![CDATA[Format a percentage for presentation to the user.
- @param done the percentage to format (0.0 to 1.0)
- @param digits the number of digits past the decimal point
- @return a string representation of the percentage]]>
- </doc>
- </method>
- <method name="arrayToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="strs" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Given an array of strings, return a comma-separated list of its elements.
- @param strs Array of strings
- @return Empty string if strs.length is 0, comma separated list of strings
- otherwise]]>
- </doc>
- </method>
- <method name="byteToHexString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="end" type="int"/>
- <doc>
- <![CDATA[Given an array of bytes it will convert the bytes to a hex string
- representation of the bytes
- @param bytes
- @param start start index, inclusively
- @param end end index, exclusively
- @return hex string representation of the byte array]]>
- </doc>
- </method>
- <method name="byteToHexString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Same as byteToHexString(bytes, 0, bytes.length).]]>
- </doc>
- </method>
- <method name="hexStringToByte" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hex" type="java.lang.String"/>
- <doc>
- <![CDATA[Given a hexstring this will return the byte array corresponding to the
- string
- @param hex the hex String array
- @return a byte array that is a hex string representation of the given
- string. The size of the byte array is therefore hex.length/2]]>
- </doc>
- </method>
- <method name="uriToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uris" type="java.net.URI[]"/>
- <doc>
- <![CDATA[@param uris]]>
- </doc>
- </method>
- <method name="stringToURI" return="java.net.URI[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String[]"/>
- <doc>
- <![CDATA[@param str]]>
- </doc>
- </method>
- <method name="stringToPath" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String[]"/>
- <doc>
- <![CDATA[@param str]]>
- </doc>
- </method>
- <method name="formatTimeDiff" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finishTime" type="long"/>
- <param name="startTime" type="long"/>
- <doc>
- <![CDATA[Given a finish and start time in long milliseconds, returns a
- String in the format Xhrs, Ymins, Z sec, for the time difference between two times.
- If finish time comes before start time then negative valeus of X, Y and Z wil return.
-
- @param finishTime finish time
- @param startTime start time]]>
- </doc>
- </method>
- <method name="formatTime" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timeDiff" type="long"/>
- <doc>
- <![CDATA[Given the time in long milliseconds, returns a
- String in the format Xhrs, Ymins, Z sec.
-
- @param timeDiff The time difference to format]]>
- </doc>
- </method>
- <method name="getFormattedTimeWithDiff" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dateFormat" type="java.text.DateFormat"/>
- <param name="finishTime" type="long"/>
- <param name="startTime" type="long"/>
- <doc>
- <![CDATA[Formats time in ms and appends difference (finishTime - startTime)
- as returned by formatTimeDiff().
- If finish time is 0, empty string is returned, if start time is 0
- then difference is not appended to return value.
- @param dateFormat date format to use
- @param finishTime fnish time
- @param startTime start time
- @return formatted value.]]>
- </doc>
- </method>
- <method name="getStrings" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns an arraylist of strings.
- @param str the comma seperated string values
- @return the arraylist of the comma seperated string values]]>
- </doc>
- </method>
- <method name="getStringCollection" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns a collection of strings.
- @param str comma seperated string values
- @return an <code>ArrayList</code> of string values]]>
- </doc>
- </method>
- <method name="split" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Split a string using the default separator
- @param str a string that may have escaped separator
- @return an array of strings]]>
- </doc>
- </method>
- <method name="split" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="escapeChar" type="char"/>
- <param name="separator" type="char"/>
- <doc>
- <![CDATA[Split a string using the given separator
- @param str a string that may have escaped separator
- @param escapeChar a char that be used to escape the separator
- @param separator a separator char
- @return an array of strings]]>
- </doc>
- </method>
- <method name="findNext" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="separator" type="char"/>
- <param name="escapeChar" type="char"/>
- <param name="start" type="int"/>
- <param name="split" type="java.lang.StringBuilder"/>
- <doc>
- <![CDATA[Finds the first occurrence of the separator character ignoring the escaped
- separators starting from the index. Note the substring between the index
- and the position of the separator is passed.
- @param str the source string
- @param separator the character to find
- @param escapeChar character used to escape
- @param start from where to search
- @param split used to pass back the extracted string]]>
- </doc>
- </method>
- <method name="escapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Escape commas in the string using the default escape char
- @param str a string
- @return an escaped string]]>
- </doc>
- </method>
- <method name="escapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="escapeChar" type="char"/>
- <param name="charToEscape" type="char"/>
- <doc>
- <![CDATA[Escape <code>charToEscape</code> in the string
- with the escape char <code>escapeChar</code>
-
- @param str string
- @param escapeChar escape char
- @param charToEscape the char to be escaped
- @return an escaped string]]>
- </doc>
- </method>
- <method name="escapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="escapeChar" type="char"/>
- <param name="charsToEscape" type="char[]"/>
- <doc>
- <![CDATA[@param charsToEscape array of characters to be escaped]]>
- </doc>
- </method>
- <method name="unEscapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Unescape commas in the string using the default escape char
- @param str a string
- @return an unescaped string]]>
- </doc>
- </method>
- <method name="unEscapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="escapeChar" type="char"/>
- <param name="charToEscape" type="char"/>
- <doc>
- <![CDATA[Unescape <code>charToEscape</code> in the string
- with the escape char <code>escapeChar</code>
-
- @param str string
- @param escapeChar escape char
- @param charToEscape the escaped char
- @return an unescaped string]]>
- </doc>
- </method>
- <method name="unEscapeString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <param name="escapeChar" type="char"/>
- <param name="charsToEscape" type="char[]"/>
- <doc>
- <![CDATA[@param charsToEscape array of characters to unescape]]>
- </doc>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return hostname without throwing exception.
- @return hostname]]>
- </doc>
- </method>
- <method name="startupShutdownMessage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clazz" type="java.lang.Class"/>
- <param name="args" type="java.lang.String[]"/>
- <param name="LOG" type="org.apache.commons.logging.Log"/>
- <doc>
- <![CDATA[Print a log message for starting up and shutting down
- @param clazz the class of the server
- @param args arguments
- @param LOG the target log object]]>
- </doc>
- </method>
- <method name="escapeHTML" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="string" type="java.lang.String"/>
- <doc>
- <![CDATA[Escapes HTML Special characters present in the string.
- @param string
- @return HTML Escaped String representation]]>
- </doc>
- </method>
- <method name="byteDesc" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="len" type="long"/>
- <doc>
- <![CDATA[Return an abbreviated English-language desc of the byte length]]>
- </doc>
- </method>
- <method name="limitDecimalTo2" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="d" type="double"/>
- </method>
- <method name="join" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="separator" type="java.lang.CharSequence"/>
- <param name="strings" type="java.lang.Iterable"/>
- <doc>
- <![CDATA[Concatenates strings, using a separator.
- @param separator Separator to join with.
- @param strings Strings to join.
- @return the joined string]]>
- </doc>
- </method>
- <method name="join" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="separator" type="java.lang.CharSequence"/>
- <param name="strings" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Concatenates strings, using a separator.
- @param separator to join with
- @param strings to join
- @return the joined string]]>
- </doc>
- </method>
- <method name="join" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="separator" type="java.lang.CharSequence"/>
- <param name="objects" type="java.lang.Object[]"/>
- <doc>
- <![CDATA[Concatenates objects, using a separator.
- @param separator to join with
- @param objects to join
- @return the joined string]]>
- </doc>
- </method>
- <method name="capitalize" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Capitalize a word
- @param s the input string
- @return capitalized string]]>
- </doc>
- </method>
- <method name="camelize" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Convert SOME_STUFF to SomeStuff
- @param s input string
- @return camelized string]]>
- </doc>
- </method>
- <field name="COMMA" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMA_STR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ESCAPE_CHAR" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[General string utils]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.StringUtils -->
- <!-- start class org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix -->
- <class name="StringUtils.TraditionalBinaryPrefix" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="valueOf" return="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="symbol" type="char"/>
- <doc>
- <![CDATA[@return The TraditionalBinaryPrefix object corresponding to the symbol.]]>
- </doc>
- </method>
- <method name="string2long" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="java.lang.String"/>
- <doc>
- <![CDATA[Convert a string to long.
- The input string is first be trimmed
- and then it is parsed with traditional binary prefix.
- For example,
- "-1230k" will be converted to -1230 * 1024 = -1259520;
- "891g" will be converted to 891 * 1024^3 = 956703965184;
- @param s input string
- @return a long value represented by the input string.]]>
- </doc>
- </method>
- <field name="KILO" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MEGA" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="GIGA" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TERA" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PETA" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EXA" type="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="value" type="long"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="symbol" type="char"
- transient="false" volatile="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The traditional binary prefixes, kilo, mega, ..., exa,
- which can be represented by a 64-bit integer.
- TraditionalBinaryPrefix symbol are case insensitive.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix -->
- <!-- start interface org.apache.hadoop.util.Tool -->
- <interface name="Tool" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Execute the command with the given arguments.
-
- @param args command specific arguments.
- @return exit code.
- @throws Exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A tool interface that supports handling of generic command-line options.
-
- <p><code>Tool</code>, is the standard for any Map-Reduce tool/application.
- The tool/application should delegate the handling of
- <a href="{@docRoot}/org/apache/hadoop/util/GenericOptionsParser.html#GenericOptions">
- standard command-line options</a> to {@link ToolRunner#run(Tool, String[])}
- and only handle its custom arguments.</p>
-
- <p>Here is how a typical <code>Tool</code> is implemented:</p>
- <p><blockquote><pre>
- public class MyApp extends Configured implements Tool {
-
- public int run(String[] args) throws Exception {
- // <code>Configuration</code> processed by <code>ToolRunner</code>
- Configuration conf = getConf();
-
- // Create a JobConf using the processed <code>conf</code>
- JobConf job = new JobConf(conf, MyApp.class);
-
- // Process custom command-line options
- Path in = new Path(args[1]);
- Path out = new Path(args[2]);
-
- // Specify various job-specific parameters
- job.setJobName("my-app");
- job.setInputPath(in);
- job.setOutputPath(out);
- job.setMapperClass(MyApp.MyMapper.class);
- job.setReducerClass(MyApp.MyReducer.class);
- // Submit the job, then poll for progress until the job is complete
- JobClient.runJob(job);
- }
-
- public static void main(String[] args) throws Exception {
- // Let <code>ToolRunner</code> handle generic command-line options
- int res = ToolRunner.run(new Configuration(), new Sort(), args);
-
- System.exit(res);
- }
- }
- </pre></blockquote></p>
-
- @see GenericOptionsParser
- @see ToolRunner]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.Tool -->
- <!-- start class org.apache.hadoop.util.ToolRunner -->
- <class name="ToolRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ToolRunner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="tool" type="org.apache.hadoop.util.Tool"/>
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Runs the given <code>Tool</code> by {@link Tool#run(String[])}, after
- parsing with the given generic arguments. Uses the given
- <code>Configuration</code>, or builds one if null.
-
- Sets the <code>Tool</code>'s configuration with the possibly modified
- version of the <code>conf</code>.
-
- @param conf <code>Configuration</code> for the <code>Tool</code>.
- @param tool <code>Tool</code> to run.
- @param args command-line arguments to the tool.
- @return exit code of the {@link Tool#run(String[])} method.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tool" type="org.apache.hadoop.util.Tool"/>
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Runs the <code>Tool</code> with its <code>Configuration</code>.
-
- Equivalent to <code>run(tool.getConf(), tool, args)</code>.
-
- @param tool <code>Tool</code> to run.
- @param args command-line arguments to the tool.
- @return exit code of the {@link Tool#run(String[])} method.]]>
- </doc>
- </method>
- <method name="printGenericCommandUsage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.PrintStream"/>
- <doc>
- <![CDATA[Prints generic command-line argurments and usage information.
-
- @param out stream to write usage information to.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A utility to help run {@link Tool}s.
-
- <p><code>ToolRunner</code> can be used to run classes implementing
- <code>Tool</code> interface. It works in conjunction with
- {@link GenericOptionsParser} to parse the
- <a href="{@docRoot}/org/apache/hadoop/util/GenericOptionsParser.html#GenericOptions">
- generic hadoop command line arguments</a> and modifies the
- <code>Configuration</code> of the <code>Tool</code>. The
- application-specific options are passed along without being modified.
- </p>
-
- @see Tool
- @see GenericOptionsParser]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.ToolRunner -->
- <!-- start class org.apache.hadoop.util.UTF8ByteArrayUtils -->
- <class name="UTF8ByteArrayUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UTF8ByteArrayUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="findByte" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="end" type="int"/>
- <param name="b" type="byte"/>
- <doc>
- <![CDATA[Find the first occurrence of the given byte b in a UTF-8 encoded string
- @param utf a byte array containing a UTF-8 encoded string
- @param start starting offset
- @param end ending position
- @param b the byte to find
- @return position that first byte occures otherwise -1]]>
- </doc>
- </method>
- <method name="findBytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="end" type="int"/>
- <param name="b" type="byte[]"/>
- <doc>
- <![CDATA[Find the first occurrence of the given bytes b in a UTF-8 encoded string
- @param utf a byte array containing a UTF-8 encoded string
- @param start starting offset
- @param end ending position
- @param b the bytes to find
- @return position that first byte occures otherwise -1]]>
- </doc>
- </method>
- <method name="findNthByte" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <param name="b" type="byte"/>
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Find the nth occurrence of the given byte b in a UTF-8 encoded string
- @param utf a byte array containing a UTF-8 encoded string
- @param start starting offset
- @param length the length of byte array
- @param b the byte to find
- @param n the desired occurrence of the given byte
- @return position that nth occurrence of the given byte if exists; otherwise -1]]>
- </doc>
- </method>
- <method name="findNthByte" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="b" type="byte"/>
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Find the nth occurrence of the given byte b in a UTF-8 encoded string
- @param utf a byte array containing a UTF-8 encoded string
- @param b the byte to find
- @param n the desired occurrence of the given byte
- @return position that nth occurrence of the given byte if exists; otherwise -1]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.util.UTF8ByteArrayUtils -->
- <!-- start class org.apache.hadoop.util.VersionInfo -->
- <class name="VersionInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="VersionInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Hadoop version.
- @return the Hadoop version string, eg. "0.6.3-dev"]]>
- </doc>
- </method>
- <method name="getRevision" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the subversion revision number for the root directory
- @return the revision number, eg. "451451"]]>
- </doc>
- </method>
- <method name="getDate" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The date that Hadoop was compiled.
- @return the compilation date in unix date format]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The user that compiled Hadoop.
- @return the username of the user]]>
- </doc>
- </method>
- <method name="getUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the subversion URL for the root Hadoop directory.]]>
- </doc>
- </method>
- <method name="getSrcChecksum" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the checksum of the source files from which Hadoop was
- built.]]>
- </doc>
- </method>
- <method name="getBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the full version string containing version,
- revision, user and source checksum.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <doc>
- <![CDATA[This class finds the package info for Hadoop and the HadoopVersionAnnotation
- information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.VersionInfo -->
- <!-- start class org.apache.hadoop.util.XMLUtils -->
- <class name="XMLUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="XMLUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="transform"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="styleSheet" type="java.io.InputStream"/>
- <param name="xml" type="java.io.InputStream"/>
- <param name="out" type="java.io.Writer"/>
- <exception name="TransformerConfigurationException" type="javax.xml.transform.TransformerConfigurationException"/>
- <exception name="TransformerException" type="javax.xml.transform.TransformerException"/>
- <doc>
- <![CDATA[Transform input xml given a stylesheet.
-
- @param styleSheet the style-sheet
- @param xml input xml data
- @param out output
- @throws TransformerConfigurationException
- @throws TransformerException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[General xml utilities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.XMLUtils -->
- </package>
- <package name="org.apache.hadoop.util.bloom">
- <!-- start class org.apache.hadoop.util.bloom.BloomFilter -->
- <class name="BloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="BloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="BloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getVectorSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return size of the the bloomfilter]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>Bloom filter</i>, as defined by Bloom in 1970.
- <p>
- The Bloom filter is a data structure that was introduced in 1970 and that has been adopted by
- the networking research community in the past decade thanks to the bandwidth efficiencies that it
- offers for the transmission of set membership information between networked hosts. A sender encodes
- the information into a bit vector, the Bloom filter, that is more compact than a conventional
- representation. Computation and space costs for construction are linear in the number of elements.
- The receiver uses the filter to test whether various elements are members of the set. Though the
- filter will occasionally return a false positive, it will never return a false negative. When creating
- the filter, the sender can choose its desired point in a trade-off between the false positive rate and the size.
-
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
-
- @see Filter The general behavior of a filter
-
- @see <a href="http://portal.acm.org/citation.cfm?id=362692&dl=ACM&coll=portal">Space/Time Trade-Offs in Hash Coding with Allowable Errors</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.BloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.CountingBloomFilter -->
- <class name="CountingBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="CountingBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="CountingBloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="delete"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Removes a specified key from <i>this</i> counting Bloom filter.
- <p>
- <b>Invariant</b>: nothing happens if the specified key does not belong to <i>this</i> counter Bloom filter.
- @param key The key to remove.]]>
- </doc>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="approximateCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[This method calculates an approximate count of the key, i.e. how many
- times the key was added to the filter. This allows the filter to be
- used as an approximate <code>key -> count</code> map.
- <p>NOTE: due to the bucket size of this filter, inserting the same
- key more than 15 times will cause an overflow at all filter positions
- associated with this key, and it will significantly increase the error
- rate for this and other keys. For this reason the filter can only be
- used to store small count values <code>0 <= N << 15</code>.
- @param key key to be tested
- @return 0 if the key is not present. Otherwise, a positive value v will
- be returned such that <code>v == count</code> with probability equal to the
- error rate of this filter, and <code>v > count</code> otherwise.
- Additionally, if the filter experienced an underflow as a result of
- {@link #delete(Key)} operation, the return value may be lower than the
- <code>count</code> with the probability of the false negative rate of such
- filter.]]>
- </doc>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>counting Bloom filter</i>, as defined by Fan et al. in a ToN
- 2000 paper.
- <p>
- A counting Bloom filter is an improvement to standard a Bloom filter as it
- allows dynamic additions and deletions of set membership information. This
- is achieved through the use of a counting vector instead of a bit vector.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
- @see Filter The general behavior of a filter
-
- @see <a href="http://portal.acm.org/citation.cfm?id=343571.343572">Summary cache: a scalable wide-area web cache sharing protocol</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.CountingBloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
- <class name="DynamicBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DynamicBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Zero-args constructor for the serialization.]]>
- </doc>
- </constructor>
- <constructor name="DynamicBloomFilter" type="int, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds an empty Dynamic Bloom filter.
- @param vectorSize The number of bits in the vector.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).
- @param nr The threshold for the maximum number of keys to record in a
- dynamic Bloom filter row.]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="and"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="not"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="or"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="xor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>dynamic Bloom filter</i>, as defined in the INFOCOM 2006 paper.
- <p>
- A dynamic Bloom filter (DBF) makes use of a <code>s * m</code> bit matrix but
- each of the <code>s</code> rows is a standard Bloom filter. The creation
- process of a DBF is iterative. At the start, the DBF is a <code>1 * m</code>
- bit matrix, i.e., it is composed of a single standard Bloom filter.
- It assumes that <code>n<sub>r</sub></code> elements are recorded in the
- initial bit vector, where <code>n<sub>r</sub> <= n</code> (<code>n</code> is
- the cardinality of the set <code>A</code> to record in the filter).
- <p>
- As the size of <code>A</code> grows during the execution of the application,
- several keys must be inserted in the DBF. When inserting a key into the DBF,
- one must first get an active Bloom filter in the matrix. A Bloom filter is
- active when the number of recorded keys, <code>n<sub>r</sub></code>, is
- strictly less than the current cardinality of <code>A</code>, <code>n</code>.
- If an active Bloom filter is found, the key is inserted and
- <code>n<sub>r</sub></code> is incremented by one. On the other hand, if there
- is no active Bloom filter, a new one is created (i.e., a new row is added to
- the matrix) according to the current size of <code>A</code> and the element
- is added in this new Bloom filter and the <code>n<sub>r</sub></code> value of
- this new Bloom filter is set to one. A given key is said to belong to the
- DBF if the <code>k</code> positions are set to one in one of the matrix rows.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
- @see Filter The general behavior of a filter
- @see BloomFilter A Bloom filter
-
- @see <a href="http://www.cse.fau.edu/~jie/research/publications/Publication_files/infocom2006.pdf">Theory and Network Applications of Dynamic Bloom Filters</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
- <!-- start class org.apache.hadoop.util.bloom.Filter -->
- <class name="Filter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Filter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Filter" type="int, int, int"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash functions to consider.
- @param hashType type of the hashing function (see {@link Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Adds a key to <i>this</i> filter.
- @param key The key to add.]]>
- </doc>
- </method>
- <method name="membershipTest" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Determines wether a specified key belongs to <i>this</i> filter.
- @param key The key to test.
- @return boolean True if the specified key belongs to <i>this</i> filter.
- False otherwise.]]>
- </doc>
- </method>
- <method name="and"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- <doc>
- <![CDATA[Peforms a logical AND between <i>this</i> filter and a specified filter.
- <p>
- <b>Invariant</b>: The result is assigned to <i>this</i> filter.
- @param filter The filter to AND with.]]>
- </doc>
- </method>
- <method name="or"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- <doc>
- <![CDATA[Peforms a logical OR between <i>this</i> filter and a specified filter.
- <p>
- <b>Invariant</b>: The result is assigned to <i>this</i> filter.
- @param filter The filter to OR with.]]>
- </doc>
- </method>
- <method name="xor"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
- <doc>
- <![CDATA[Peforms a logical XOR between <i>this</i> filter and a specified filter.
- <p>
- <b>Invariant</b>: The result is assigned to <i>this</i> filter.
- @param filter The filter to XOR with.]]>
- </doc>
- </method>
- <method name="not"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Performs a logical NOT on <i>this</i> filter.
- <p>
- The result is assigned to <i>this</i> filter.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="java.util.List"/>
- <doc>
- <![CDATA[Adds a list of keys to <i>this</i> filter.
- @param keys The list of keys.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="java.util.Collection"/>
- <doc>
- <![CDATA[Adds a collection of keys to <i>this</i> filter.
- @param keys The collection of keys.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="org.apache.hadoop.util.bloom.Key[]"/>
- <doc>
- <![CDATA[Adds an array of keys to <i>this</i> filter.
- @param keys The array of keys.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="vectorSize" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The vector size of <i>this</i> filter.]]>
- </doc>
- </field>
- <field name="hash" type="org.apache.hadoop.util.bloom.HashFunction"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The hash function used to map a key to several positions in the vector.]]>
- </doc>
- </field>
- <field name="nbHash" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of hash function to consider.]]>
- </doc>
- </field>
- <field name="hashType" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Type of hashing function to use.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Defines the general behavior of a filter.
- <p>
- A filter is a data structure which aims at offering a lossy summary of a set <code>A</code>. The
- key idea is to map entries of <code>A</code> (also called <i>keys</i>) into several positions
- in a vector through the use of several hash functions.
- <p>
- Typically, a filter will be implemented as a Bloom filter (or a Bloom filter extension).
- <p>
- It must be extended in order to define the real behavior.
-
- @see Key The general behavior of a key
- @see HashFunction A hash function]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.Filter -->
- <!-- start class org.apache.hadoop.util.bloom.HashFunction -->
- <class name="HashFunction" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="HashFunction" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds a hash function that must obey to a given maximum number of returned values and a highest value.
- @param maxValue The maximum highest returned value.
- @param nbHash The number of resulting hashed values.
- @param hashType type of the hashing function (see {@link Hash}).]]>
- </doc>
- </constructor>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clears <i>this</i> hash function. A NOOP]]>
- </doc>
- </method>
- <method name="hash" return="int[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="k" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Hashes a specified key into several integers.
- @param k The specified key.
- @return The array of hashed values.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implements a hash object that returns a certain number of hashed values.
-
- @see Key The general behavior of a key being stored in a filter
- @see Filter The general behavior of a filter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.HashFunction -->
- <!-- start class org.apache.hadoop.util.bloom.Key -->
- <class name="Key" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="Key"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="Key" type="byte[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds a key with a default weight.
- @param value The byte value of <i>this</i> key.]]>
- </doc>
- </constructor>
- <constructor name="Key" type="byte[], double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- <p>
- Builds a key with a specified weight.
- @param value The value of <i>this</i> key.
- @param weight The weight associated to <i>this</i> key.]]>
- </doc>
- </constructor>
- <method name="set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="byte[]"/>
- <param name="weight" type="double"/>
- <doc>
- <![CDATA[@param value
- @param weight]]>
- </doc>
- </method>
- <method name="getBytes" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return byte[] The value of <i>this</i> key.]]>
- </doc>
- </method>
- <method name="getWeight" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Returns the weight associated to <i>this</i> key.]]>
- </doc>
- </method>
- <method name="incrementWeight"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="weight" type="double"/>
- <doc>
- <![CDATA[Increments the weight of <i>this</i> key with a specified value.
- @param weight The increment.]]>
- </doc>
- </method>
- <method name="incrementWeight"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Increments the weight of <i>this</i> key by one.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <doc>
- <![CDATA[The general behavior of a key that must be stored in a filter.
-
- @see Filter The general behavior of a filter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.Key -->
- <!-- start interface org.apache.hadoop.util.bloom.RemoveScheme -->
- <interface name="RemoveScheme" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="RANDOM" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Random selection.
- <p>
- The idea is to randomly select a bit to reset.]]>
- </doc>
- </field>
- <field name="MINIMUM_FN" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[MinimumFN Selection.
- <p>
- The idea is to select the bit to reset that will generate the minimum
- number of false negative.]]>
- </doc>
- </field>
- <field name="MAXIMUM_FP" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[MaximumFP Selection.
- <p>
- The idea is to select the bit to reset that will remove the maximum number
- of false positive.]]>
- </doc>
- </field>
- <field name="RATIO" type="short"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Ratio Selection.
- <p>
- The idea is to select the bit to reset that will, at the same time, remove
- the maximum number of false positve while minimizing the amount of false
- negative generated.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Defines the different remove scheme for retouched Bloom filters.
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.util.bloom.RemoveScheme -->
- <!-- start class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
- <class name="RetouchedBloomFilter" extends="org.apache.hadoop.util.bloom.BloomFilter"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.bloom.RemoveScheme"/>
- <constructor name="RetouchedBloomFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor - use with readFields]]>
- </doc>
- </constructor>
- <constructor name="RetouchedBloomFilter" type="int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
- @param vectorSize The vector size of <i>this</i> filter.
- @param nbHash The number of hash function to consider.
- @param hashType type of the hashing function (see
- {@link org.apache.hadoop.util.hash.Hash}).]]>
- </doc>
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.util.bloom.Key"/>
- <doc>
- <![CDATA[Adds a false positive information to <i>this</i> retouched Bloom filter.
- <p>
- <b>Invariant</b>: if the false positive is <code>null</code>, nothing happens.
- @param key The false positive key to add.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="coll" type="java.util.Collection"/>
- <doc>
- <![CDATA[Adds a collection of false positive information to <i>this</i> retouched Bloom filter.
- @param coll The collection of false positive.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="java.util.List"/>
- <doc>
- <![CDATA[Adds a list of false positive information to <i>this</i> retouched Bloom filter.
- @param keys The list of false positive.]]>
- </doc>
- </method>
- <method name="addFalsePositive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keys" type="org.apache.hadoop.util.bloom.Key[]"/>
- <doc>
- <![CDATA[Adds an array of false positive information to <i>this</i> retouched Bloom filter.
- @param keys The array of false positive.]]>
- </doc>
- </method>
- <method name="selectiveClearing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="k" type="org.apache.hadoop.util.bloom.Key"/>
- <param name="scheme" type="short"/>
- <doc>
- <![CDATA[Performs the selective clearing for a given key.
- @param k The false positive key to remove from <i>this</i> retouched Bloom filter.
- @param scheme The selective clearing scheme to apply.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Implements a <i>retouched Bloom filter</i>, as defined in the CoNEXT 2006 paper.
- <p>
- It allows the removal of selected false positives at the cost of introducing
- random false negatives, and with the benefit of eliminating some random false
- positives at the same time.
-
- <p>
- Originally created by
- <a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
-
- @see Filter The general behavior of a filter
- @see BloomFilter A Bloom filter
- @see RemoveScheme The different selective clearing algorithms
-
- @see <a href="http://www-rp.lip6.fr/site_npa/site_rp/_publications/740-rbf_cameraready.pdf">Retouched Bloom Filters: Allowing Networked Applications to Trade Off Selected False Positives Against False Negatives</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
- </package>
- <package name="org.apache.hadoop.util.hash">
- <!-- start class org.apache.hadoop.util.hash.Hash -->
- <class name="Hash" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Hash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="parseHashType" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[This utility method converts String representation of hash function name
- to a symbolic constant. Currently two function types are supported,
- "jenkins" and "murmur".
- @param name hash function name
- @return one of the predefined constants]]>
- </doc>
- </method>
- <method name="getHashType" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[This utility method converts the name of the configured
- hash type to a symbolic constant.
- @param conf configuration
- @return one of the predefined constants]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.util.hash.Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="int"/>
- <doc>
- <![CDATA[Get a singleton instance of hash function of a given type.
- @param type predefined hash type
- @return hash function instance, or null if type is invalid]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.util.hash.Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get a singleton instance of hash function of a type
- defined in the configuration.
- @param conf current configuration
- @return defined hash type, or null if type is invalid]]>
- </doc>
- </method>
- <method name="hash" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <doc>
- <![CDATA[Calculate a hash using all bytes from the input argument, and
- a seed of -1.
- @param bytes input bytes
- @return hash value]]>
- </doc>
- </method>
- <method name="hash" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="initval" type="int"/>
- <doc>
- <![CDATA[Calculate a hash using all bytes from the input argument,
- and a provided seed value.
- @param bytes input bytes
- @param initval seed value
- @return hash value]]>
- </doc>
- </method>
- <method name="hash" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="bytes" type="byte[]"/>
- <param name="length" type="int"/>
- <param name="initval" type="int"/>
- <doc>
- <![CDATA[Calculate a hash using bytes from 0 to <code>length</code>, and
- the provided seed value
- @param bytes input bytes
- @param length length of the valid bytes to consider
- @param initval seed value
- @return hash value]]>
- </doc>
- </method>
- <field name="INVALID_HASH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant to denote invalid hash type.]]>
- </doc>
- </field>
- <field name="JENKINS_HASH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant to denote {@link JenkinsHash}.]]>
- </doc>
- </field>
- <field name="MURMUR_HASH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constant to denote {@link MurmurHash}.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This class represents a common API for hashing functions.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.hash.Hash -->
- <!-- start class org.apache.hadoop.util.hash.JenkinsHash -->
- <class name="JenkinsHash" extends="org.apache.hadoop.util.hash.Hash"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JenkinsHash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.util.hash.Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hash" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <param name="nbytes" type="int"/>
- <param name="initval" type="int"/>
- <doc>
- <![CDATA[taken from hashlittle() -- hash a variable-length key into a 32-bit value
-
- @param key the key (the unaligned variable-length array of bytes)
- @param nbytes number of bytes to include in hash
- @param initval can be any integer value
- @return a 32-bit value. Every bit of the key affects every bit of the
- return value. Two keys differing by one or two bits will have totally
- different hash values.
-
- <p>The best hash table sizes are powers of 2. There is no need to do mod
- a prime (mod is sooo slow!). If you need less than 32 bits, use a bitmask.
- For example, if you need only 10 bits, do
- <code>h = (h & hashmask(10));</code>
- In which case, the hash table should have hashsize(10) elements.
-
- <p>If you are hashing n strings byte[][] k, do it like this:
- for (int i = 0, h = 0; i < n; ++i) h = hash( k[i], h);
-
- <p>By Bob Jenkins, 2006. bob_jenkins@burtleburtle.net. You may use this
- code any way you wish, private, educational, or commercial. It's free.
-
- <p>Use for hash table lookup, or anything where one collision in 2^^32 is
- acceptable. Do NOT use for cryptographic purposes.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Compute the hash of the specified file
- @param args name of file to compute hash of.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Produces 32-bit hash for hash table lookup.
-
- <pre>lookup3.c, by Bob Jenkins, May 2006, Public Domain.
- You can use this free for any purpose. It's in the public domain.
- It has no warranty.
- </pre>
-
- @see <a href="http://burtleburtle.net/bob/c/lookup3.c">lookup3.c</a>
- @see <a href="http://www.ddj.com/184410284">Hash Functions (and how this
- function compares to others such as CRC, MD?, etc</a>
- @see <a href="http://burtleburtle.net/bob/hash/doobs.html">Has update on the
- Dr. Dobbs Article</a>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.hash.JenkinsHash -->
- <!-- start class org.apache.hadoop.util.hash.MurmurHash -->
- <class name="MurmurHash" extends="org.apache.hadoop.util.hash.Hash"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MurmurHash"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.util.hash.Hash"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hash" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="data" type="byte[]"/>
- <param name="length" type="int"/>
- <param name="seed" type="int"/>
- </method>
- <doc>
- <![CDATA[This is a very fast, non-cryptographic hash suitable for general hash-based
- lookup. See http://murmurhash.googlepages.com/ for more details.
-
- <p>The C version of MurmurHash 2.0 found at that site was ported
- to Java by Andrzej Bialecki (ab at getopt org).</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.util.hash.MurmurHash -->
- </package>
- <package name="org.apache.hadoop.filecache">
- <!-- start class org.apache.hadoop.filecache.DistributedCache -->
- <class name="DistributedCache" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DistributedCache"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="cache" type="java.net.URI"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns {@link FileStatus} of a given cache file on hdfs. Internal to
- MapReduce.
- @param conf configuration
- @param cache cache file
- @return <code>FileStatus</code> of a given cache file on hdfs
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="cache" type="java.net.URI"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns mtime of a given cache file on hdfs. Internal to MapReduce.
- @param conf configuration
- @param cache cache file
- @return mtime of a given cache file on hdfs
- @throws IOException]]>
- </doc>
- </method>
- <method name="createAllSymlink"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Internal to MapReduce framework. Use DistributedCacheManager
- instead.">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="jobCacheDir" type="java.io.File"/>
- <param name="workDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method create symlinks for all files in a given dir in another directory
- @param conf the configuration
- @param jobCacheDir the target directory for creating symlinks
- @param workDir the directory in which the symlinks are created
- @throws IOException
- @deprecated Internal to MapReduce framework. Use DistributedCacheManager
- instead.]]>
- </doc>
- </method>
- <method name="setCacheArchives"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="archives" type="java.net.URI[]"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration with the given set of archives. Intended
- to be used by user code.
- @param archives The list of archives that need to be localized
- @param conf Configuration which will be changed]]>
- </doc>
- </method>
- <method name="setCacheFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="files" type="java.net.URI[]"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Set the configuration with the given set of files. Intended to be
- used by user code.
- @param files The list of files that need to be localized
- @param conf Configuration which will be changed]]>
- </doc>
- </method>
- <method name="getCacheArchives" return="java.net.URI[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get cache archives set in the Configuration. Used by
- internal DistributedCache and MapReduce code.
- @param conf The configuration which contains the archives
- @return An array of the caches set in the Configuration
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCacheFiles" return="java.net.URI[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get cache files set in the Configuration. Used by internal
- DistributedCache and MapReduce code.
- @param conf The configuration which contains the files
- @return Am array of the files set in the Configuration
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocalCacheArchives" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the path array of the localized caches. Intended to be used
- by user code.
- @param conf Configuration that contains the localized archives
- @return A path array of localized caches
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocalCacheFiles" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the path array of the localized files. Intended to be used
- by user code.
- @param conf Configuration that contains the localized files
- @return A path array of localized files
- @throws IOException]]>
- </doc>
- </method>
- <method name="getArchiveTimestamps" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the timestamps of the archives. Used by internal
- DistributedCache and MapReduce code.
- @param conf The configuration which stored the timestamps
- @return a long array of timestamps
- @throws IOException]]>
- </doc>
- </method>
- <method name="getFileTimestamps" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the timestamps of the files. Used by internal
- DistributedCache and MapReduce code.
- @param conf The configuration which stored the timestamps
- @return a long array of timestamps
- @throws IOException]]>
- </doc>
- </method>
- <method name="setArchiveTimestamps"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="timestamps" type="java.lang.String"/>
- <doc>
- <![CDATA[This is to check the timestamp of the archives to be localized.
- Used by internal MapReduce code.
- @param conf Configuration which stores the timestamp's
- @param timestamps comma separated list of timestamps of archives.
- The order should be the same as the order in which the archives are added.]]>
- </doc>
- </method>
- <method name="setFileTimestamps"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="timestamps" type="java.lang.String"/>
- <doc>
- <![CDATA[This is to check the timestamp of the files to be localized.
- Used by internal MapReduce code.
- @param conf Configuration which stores the timestamp's
- @param timestamps comma separated list of timestamps of files.
- The order should be the same as the order in which the files are added.]]>
- </doc>
- </method>
- <method name="setLocalArchives"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the conf to contain the location for localized archives. Used
- by internal DistributedCache code.
- @param conf The conf to modify to contain the localized caches
- @param str a comma separated list of local archives]]>
- </doc>
- </method>
- <method name="setLocalFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the conf to contain the location for localized files. Used
- by internal DistributedCache code.
- @param conf The conf to modify to contain the localized caches
- @param str a comma separated list of local files]]>
- </doc>
- </method>
- <method name="addLocalArchives"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a archive that has been localized to the conf. Used
- by internal DistributedCache code.
- @param conf The conf to modify to contain the localized caches
- @param str a comma separated list of local archives]]>
- </doc>
- </method>
- <method name="addLocalFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="str" type="java.lang.String"/>
- <doc>
- <![CDATA[Add a file that has been localized to the conf.. Used
- by internal DistributedCache code.
- @param conf The conf to modify to contain the localized caches
- @param str a comma separated list of local files]]>
- </doc>
- </method>
- <method name="addCacheArchive"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Add a archives to be localized to the conf. Intended to
- be used by user code.
- @param uri The uri of the cache to be localized
- @param conf Configuration to add the cache to]]>
- </doc>
- </method>
- <method name="addCacheFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.net.URI"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Add a file to be localized to the conf. Intended
- to be used by user code.
- @param uri The uri of the cache to be localized
- @param conf Configuration to add the cache to]]>
- </doc>
- </method>
- <method name="addFileToClassPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Please use {@link #addFileToClassPath(Path, Configuration, FileSystem)}
- instead. The {@code FileSystem} should be obtained within an
- appropriate {@code doAs}.">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a file path to the current set of classpath entries. It adds the file
- to cache as well. Intended to be used by user code.
- @deprecated
- Please use {@link #addFileToClassPath(Path, Configuration, FileSystem)}
- instead. The {@code FileSystem} should be obtained within an
- appropriate {@code doAs}.
-
- @param file Path of the file to be added
- @param conf Configuration that contains the classpath setting]]>
- </doc>
- </method>
- <method name="addFileToClassPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a file path to the current set of classpath entries. It adds the file
- to cache as well. Intended to be used by user code.
-
- @param file Path of the file to be added
- @param conf Configuration that contains the classpath setting
- @param fs FileSystem with respect to which {@code archivefile} should
- be interpreted.]]>
- </doc>
- </method>
- <method name="getFileClassPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the file entries in classpath as an array of Path.
- Used by internal DistributedCache code.
-
- @param conf Configuration that contains the classpath setting]]>
- </doc>
- </method>
- <method name="addArchiveToClassPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Please use {@link #addArchiveToClassPath(Path, Configuration, FileSystem)}
- instead. The {@code FileSystem} should be obtained within an
- appropriate {@code doAs}.">
- <param name="archive" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add an archive path to the current set of classpath entries. It adds the
- archive to cache as well. Intended to be used by user code.
- @deprecated
- Please use {@link #addArchiveToClassPath(Path, Configuration, FileSystem)}
- instead. The {@code FileSystem} should be obtained within an
- appropriate {@code doAs}.
-
- @param archive Path of the archive to be added
- @param conf Configuration that contains the classpath setting]]>
- </doc>
- </method>
- <method name="addArchiveToClassPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="archive" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add an archive path to the current set of classpath entries. It adds the
- archive to cache as well. Intended to be used by user code.
-
- @param archive Path of the archive to be added
- @param conf Configuration that contains the classpath setting
- @param fs FileSystem with respect to which {@code archive} should be interpreted.]]>
- </doc>
- </method>
- <method name="getArchiveClassPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the archive entries in classpath as an array of Path.
- Used by internal DistributedCache code.
-
- @param conf Configuration that contains the classpath setting]]>
- </doc>
- </method>
- <method name="createSymlink"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[This method allows you to create symlinks in the current working directory
- of the task to all the cache files/archives.
- Intended to be used by user code.
- @param conf the jobconf]]>
- </doc>
- </method>
- <method name="getSymlink" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[This method checks to see if symlinks are to be create for the
- localized cache files in the current working directory
- Used by internal DistributedCache code.
- @param conf the jobconf
- @return true if symlinks are to be created- else return false]]>
- </doc>
- </method>
- <method name="checkURIs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uriFiles" type="java.net.URI[]"/>
- <param name="uriArchives" type="java.net.URI[]"/>
- <doc>
- <![CDATA[This method checks if there is a conflict in the fragment names
- of the uris. Also makes sure that each uri has a fragment. It
- is only to be called if you want to create symlinks for
- the various archives and files. May be used by user code.
- @param uriFiles The uri array of urifiles
- @param uriArchives the uri array of uri archives]]>
- </doc>
- </method>
- <field name="CACHE_FILES_SIZES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_FILES_SIZES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_ARCHIVES_SIZES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_ARCHIVES_SIZES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_ARCHIVES_TIMESTAMPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_ARCHIVES_TIMESTAMPS} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_FILES_TIMESTAMPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_FILES_TIMESTAMPS} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_ARCHIVES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_ARCHIVES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_FILES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_FILES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_LOCALARCHIVES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_LOCALARCHIVES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_LOCALFILES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_LOCALFILES} is not a *public* constant.]]>
- </doc>
- </field>
- <field name="CACHE_SYMLINK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Warning: {@link #CACHE_SYMLINK} is not a *public* constant.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Distribute application-specific large, read-only files efficiently.
-
- <p><code>DistributedCache</code> is a facility provided by the Map-Reduce
- framework to cache files (text, archives, jars etc.) needed by applications.
- </p>
-
- <p>Applications specify the files, via urls (hdfs:// or http://) to be cached
- via the {@link org.apache.hadoop.mapred.JobConf}.
- The <code>DistributedCache</code> assumes that the
- files specified via hdfs:// urls are already present on the
- {@link FileSystem} at the path specified by the url.</p>
-
- <p>The framework will copy the necessary files on to the slave node before
- any tasks for the job are executed on that node. Its efficiency stems from
- the fact that the files are only copied once per job and the ability to
- cache archives which are un-archived on the slaves.</p>
- <p><code>DistributedCache</code> can be used to distribute simple, read-only
- data/text files and/or more complex types such as archives, jars etc.
- Archives (zip, tar and tgz/tar.gz files) are un-archived at the slave nodes.
- Jars may be optionally added to the classpath of the tasks, a rudimentary
- software distribution mechanism. Files have execution permissions.
- Optionally users can also direct it to symlink the distributed cache file(s)
- into the working directory of the task.</p>
-
- <p><code>DistributedCache</code> tracks modification timestamps of the cache
- files. Clearly the cache files should not be modified by the application
- or externally while the job is executing.</p>
-
- <p>Here is an illustrative example on how to use the
- <code>DistributedCache</code>:</p>
- <p><blockquote><pre>
- // Setting up the cache for the application
-
- 1. Copy the requisite files to the <code>FileSystem</code>:
-
- $ bin/hadoop fs -copyFromLocal lookup.dat /myapp/lookup.dat
- $ bin/hadoop fs -copyFromLocal map.zip /myapp/map.zip
- $ bin/hadoop fs -copyFromLocal mylib.jar /myapp/mylib.jar
- $ bin/hadoop fs -copyFromLocal mytar.tar /myapp/mytar.tar
- $ bin/hadoop fs -copyFromLocal mytgz.tgz /myapp/mytgz.tgz
- $ bin/hadoop fs -copyFromLocal mytargz.tar.gz /myapp/mytargz.tar.gz
-
- 2. Setup the application's <code>JobConf</code>:
-
- JobConf job = new JobConf();
- DistributedCache.addCacheFile(new URI("/myapp/lookup.dat#lookup.dat"),
- job);
- DistributedCache.addCacheArchive(new URI("/myapp/map.zip", job);
- DistributedCache.addFileToClassPath(new Path("/myapp/mylib.jar"), job);
- DistributedCache.addCacheArchive(new URI("/myapp/mytar.tar", job);
- DistributedCache.addCacheArchive(new URI("/myapp/mytgz.tgz", job);
- DistributedCache.addCacheArchive(new URI("/myapp/mytargz.tar.gz", job);
-
- 3. Use the cached files in the {@link org.apache.hadoop.mapred.Mapper}
- or {@link org.apache.hadoop.mapred.Reducer}:
-
- public static class MapClass extends MapReduceBase
- implements Mapper<K, V, K, V> {
-
- private Path[] localArchives;
- private Path[] localFiles;
-
- public void configure(JobConf job) {
- // Get the cached archives/files
- localArchives = DistributedCache.getLocalCacheArchives(job);
- localFiles = DistributedCache.getLocalCacheFiles(job);
- }
-
- public void map(K key, V value,
- OutputCollector<K, V> output, Reporter reporter)
- throws IOException {
- // Use data from the cached archives/files here
- // ...
- // ...
- output.collect(k, v);
- }
- }
-
- </pre></blockquote></p>
- It is also very common to use the DistributedCache by using
- {@link org.apache.hadoop.util.GenericOptionsParser}.
- This class includes methods that should be used by users
- (specifically those mentioned in the example above, as well
- as {@link DistributedCache#addArchiveToClassPath(Path, Configuration)}),
- as well as methods intended for use by the MapReduce framework
- (e.g., {@link org.apache.hadoop.mapred.JobClient}). For implementation
- details, see {@link TrackerDistributedCacheManager} and
- {@link TaskDistributedCacheManager}.
- @see TrackerDistributedCacheManager
- @see TaskDistributedCacheManager
- @see org.apache.hadoop.mapred.JobConf
- @see org.apache.hadoop.mapred.JobClient]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.filecache.DistributedCache -->
- <!-- start class org.apache.hadoop.filecache.TaskDistributedCacheManager -->
- <class name="TaskDistributedCacheManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setupCache"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskConf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="publicCacheSubdir" type="java.lang.String"/>
- <param name="privateCacheSubdir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieve public distributed cache files into the local cache and updates
- the task configuration (which has been passed in via the constructor).
- The private distributed cache is just looked at and the paths where the
- files/archives should go to is decided here. The actual localization is
- done by {@link JobLocalizer}.
-
- It is the caller's responsibility to re-write the task configuration XML
- file, if necessary.]]>
- </doc>
- </method>
- <method name="getClassPaths" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieves class paths (as local references) to add.
- Should be called after setup().]]>
- </doc>
- </method>
- <method name="release"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Releases the cached files/archives, so that space
- can be reclaimed by the {@link TrackerDistributedCacheManager}.]]>
- </doc>
- </method>
- <method name="setSizes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sizes" type="long[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="makeClassLoader" return="java.lang.ClassLoader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parent" type="java.lang.ClassLoader"/>
- <exception name="MalformedURLException" type="java.net.MalformedURLException"/>
- <doc>
- <![CDATA[Creates a class loader that includes the designated
- files and archives.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helper class of {@link TrackerDistributedCacheManager} that represents
- the cached files of a single job.
-
- <b>This class is internal to Hadoop, and should not be treated as a public
- interface.</b>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.filecache.TaskDistributedCacheManager -->
- <!-- start class org.apache.hadoop.filecache.TrackerDistributedCacheManager -->
- <class name="TrackerDistributedCacheManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TrackerDistributedCacheManager" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.TaskController"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="downloadCacheObject" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="source" type="java.net.URI"/>
- <param name="destination" type="org.apache.hadoop.fs.Path"/>
- <param name="desiredTimestamp" type="long"/>
- <param name="isArchive" type="boolean"/>
- <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Download a given path to the local file system.
- @param conf the job's configuration
- @param source the source to copy from
- @param destination where to copy the file. must be local fs
- @param desiredTimestamp the required modification timestamp of the source
- @param isArchive is this an archive that should be expanded
- @param permission the desired permissions of the file.
- @return for archives, the number of bytes in the unpacked directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="createAllSymlink"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="jobCacheDir" type="java.io.File"/>
- <param name="workDir" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method create symlinks for all files in a given dir in another
- directory.
-
- Should not be used outside of DistributedCache code.
-
- @param conf the configuration
- @param jobCacheDir the target directory for creating symlinks
- @param workDir the directory in which the symlinks are created
- @throws IOException]]>
- </doc>
- </method>
- <method name="purgeCache"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Clear the entire contents of the cache and delete the backing files. This
- should only be used when the server is reinitializing, because the users
- are going to lose their files.]]>
- </doc>
- </method>
- <method name="newTaskDistributedCacheManager" return="org.apache.hadoop.filecache.TaskDistributedCacheManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="taskConf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setArchiveSizes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="sizes" type="long[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the sizes for any archives, files, or directories in the private
- distributed cache.]]>
- </doc>
- </method>
- <method name="removeTaskDistributedCacheManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- </method>
- <method name="getTaskDistributedCacheManager" return="org.apache.hadoop.filecache.TaskDistributedCacheManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- </method>
- <method name="determineTimestampsAndCacheVisibilities"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Determines timestamps of files to be cached, and stores those
- in the configuration. Determines the visibilities of the distributed cache
- files and archives. The visibility of a cache path is "public" if the leaf
- component has READ permissions for others, and the parent subdirs have
- EXECUTE permissions for others.
-
- This is an internal method!
-
- @param job
- @throws IOException]]>
- </doc>
- </method>
- <method name="getFileVisibilities" return="boolean[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the booleans on whether the files are public or not. Used by
- internal DistributedCache and MapReduce code.
- @param conf The configuration which stored the timestamps
- @return array of booleans
- @throws IOException]]>
- </doc>
- </method>
- <method name="getArchiveVisibilities" return="boolean[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the booleans on whether the archives are public or not. Used by
- internal DistributedCache and MapReduce code.
- @param conf The configuration which stored the timestamps
- @return array of booleans]]>
- </doc>
- </method>
- <method name="getDelegationTokens"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For each archive or cache file - get the corresponding delegation token
- @param job
- @param credentials
- @throws IOException]]>
- </doc>
- </method>
- <method name="validate"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="InvalidJobConfException" type="org.apache.hadoop.mapred.InvalidJobConfException"/>
- <doc>
- <![CDATA[This is part of the framework API. It's called within the job
- submission code only, not by users. In the non-error case it has
- no side effects and returns normally. If there's a URI in both
- mapred.cache.files and mapred.cache.archives, it throws its
- exception.
- @param conf a {@link Configuration} to be cheked for duplication
- in cached URIs
- @throws InvalidJobConfException]]>
- </doc>
- </method>
- <method name="startCleanupThread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start the background thread]]>
- </doc>
- </method>
- <method name="stopCleanupThread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Stop the background thread]]>
- </doc>
- </method>
- <field name="baseDirManager" type="org.apache.hadoop.filecache.TrackerDistributedCacheManager.BaseDirManager"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="cleanupThread" type="org.apache.hadoop.filecache.TrackerDistributedCacheManager.CleanupThread"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Manages a single machine's instance of a cross-job
- cache. This class would typically be instantiated
- by a TaskTracker (or something that emulates it,
- like LocalJobRunner).
-
- <b>This class is internal to Hadoop, and should not be treated as a public
- interface.</b>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.filecache.TrackerDistributedCacheManager -->
- <!-- start class org.apache.hadoop.filecache.TrackerDistributedCacheManager.BaseDirManager -->
- <class name="TrackerDistributedCacheManager.BaseDirManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="TrackerDistributedCacheManager.BaseDirManager"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="deleteCacheInfoUpdate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cacheStatus" type="org.apache.hadoop.filecache.TrackerDistributedCacheManager.CacheStatus"/>
- <doc>
- <![CDATA[Decrement the size and sub directory count of the cache from baseDirSize
- and baseDirNumberSubDir. Have to lock lcacheStatus before calling this.
- @param cacheStatus cache status of the cache is deleted]]>
- </doc>
- </method>
- <method name="addCacheInfoUpdate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cacheStatus" type="org.apache.hadoop.filecache.TrackerDistributedCacheManager.CacheStatus"/>
- <doc>
- <![CDATA[Update the maps baseDirSize and baseDirNumberSubDir when adding cache.
- Increase the size and sub directory count of the cache from baseDirSize
- and baseDirNumberSubDir. Have to lock lcacheStatus before calling this.
- @param cacheStatus cache status of the cache is added]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class holds properties of each base directories and is responsible
- for clean up unused cache files in base directories.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.filecache.TrackerDistributedCacheManager.BaseDirManager -->
- <!-- start class org.apache.hadoop.filecache.TrackerDistributedCacheManager.CleanupThread -->
- <class name="TrackerDistributedCacheManager.CleanupThread" extends="java.lang.Thread"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="TrackerDistributedCacheManager.CleanupThread" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="stopRunning"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="exitTaskTracker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="t" type="java.lang.Throwable"/>
- <doc>
- <![CDATA[Exit the task tracker because of a fatal error.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A thread to check and cleanup the unused files periodically]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.filecache.TrackerDistributedCacheManager.CleanupThread -->
- </package>
- <package name="org.apache.hadoop.mapred">
- <!-- start interface org.apache.hadoop.mapred.AdminOperationsProtocol -->
- <interface name="AdminOperationsProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- <method name="refreshQueues"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh the queue acls in use currently.
- Refresh the queues used by the jobtracker and scheduler.
- Access control lists and queue states are refreshed.]]>
- </doc>
- </method>
- <method name="refreshNodes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Refresh the node list at the {@link JobTracker}]]>
- </doc>
- </method>
- <method name="setSafeMode" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="safeModeAction" type="org.apache.hadoop.mapred.JobTracker.SafeModeAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set safe mode for the JobTracker.
- @param safeModeAction safe mode action
- @return current safemode
- @throws IOException]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Version 1: Initial version. Added refreshQueueAcls.
- Version 2: Added node refresh facility
- Version 3: Changed refreshQueueAcls to refreshQueues]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Protocol for admin operations. This is a framework-public interface and is
- NOT_TO_BE_USED_BY_USERS_DIRECTLY.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.AdminOperationsProtocol -->
- <!-- start class org.apache.hadoop.mapred.CleanupQueue -->
- <class name="CleanupQueue" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CleanupQueue"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a singleton path-clean-up queue. It can be used to delete
- paths(directories/files) in a separate thread. This constructor creates a
- clean-up thread and also starts it as a daemon. Callers can instantiate one
- CleanupQueue per JVM and can use it for deleting paths. Use
- {@link CleanupQueue#addToQueue(PathDeletionContext...)} to add paths for
- deletion.]]>
- </doc>
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.mapred.CleanupQueue"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addToQueue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="contexts" type="org.apache.hadoop.mapred.CleanupQueue.PathDeletionContext[]"/>
- <doc>
- <![CDATA[Adds the paths to the queue of paths to be deleted by cleanupThread.]]>
- </doc>
- </method>
- <method name="isQueueEmpty" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.CleanupQueue -->
- <!-- start class org.apache.hadoop.mapred.ClusterStatus -->
- <class name="ClusterStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <method name="getTaskTrackers" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of active task trackers in the cluster. Includes
- graylisted but not blacklisted trackers.
- @return the number of active task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getActiveTrackerNames" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the names of active task trackers in the cluster. Includes
- graylisted but not blacklisted trackers.
- @return the active task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getBlacklistedTrackerNames" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the names of blacklisted task trackers in the cluster.
-
- @return the blacklisted task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getBlacklistedTrackers" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of blacklisted task trackers in the cluster.
-
- @return the number of blacklisted task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getGraylistedTrackerNames" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the names of graylisted task trackers in the cluster.
-
- @return the graylisted task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getGraylistedTrackers" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of graylisted task trackers in the cluster.
-
- @return the number of graylisted task trackers in the cluster.]]>
- </doc>
- </method>
- <method name="getNumExcludedNodes" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of excluded hosts in the cluster.
- @return the number of excluded hosts in the cluster.]]>
- </doc>
- </method>
- <method name="getTTExpiryInterval" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the tasktracker expiry interval for the cluster
- @return the expiry interval in msec]]>
- </doc>
- </method>
- <method name="getMapTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of currently running map tasks in the cluster.
-
- @return the number of currently running map tasks in the cluster.]]>
- </doc>
- </method>
- <method name="getReduceTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of currently running reduce tasks in the cluster.
-
- @return the number of currently running reduce tasks in the cluster.]]>
- </doc>
- </method>
- <method name="getMaxMapTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capacity for running map tasks in the cluster.
-
- @return the maximum capacity for running map tasks in the cluster.]]>
- </doc>
- </method>
- <method name="getMaxReduceTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capacity for running reduce tasks in the cluster.
-
- @return the maximum capacity for running reduce tasks in the cluster.]]>
- </doc>
- </method>
- <method name="getJobTrackerState" return="org.apache.hadoop.mapred.JobTracker.State"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current state of the <code>JobTracker</code>,
- as {@link JobTracker.State}
-
- @return the current state of the <code>JobTracker</code>.]]>
- </doc>
- </method>
- <method name="getUsedMemory" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total heap memory used by the <code>JobTracker</code>
-
- @return the size of heap memory used by the <code>JobTracker</code>]]>
- </doc>
- </method>
- <method name="getMaxMemory" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum configured heap memory that can be used by the <code>JobTracker</code>
-
- @return the configured size of max heap memory that can be used by the <code>JobTracker</code>]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="UNINITIALIZED_MEMORY_VALUE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Status information on the current state of the Map-Reduce cluster.
-
- <p><code>ClusterStatus</code> provides clients with information such as:
- <ol>
- <li>
- Size of the cluster.
- </li>
- <li>
- Name of the trackers.
- </li>
- <li>
- Task capacity of the cluster.
- </li>
- <li>
- The number of currently running map & reduce tasks.
- </li>
- <li>
- State of the <code>JobTracker</code>.
- </li>
- </ol></p>
-
- <p>Clients can query for the latest <code>ClusterStatus</code>, via
- {@link JobClient#getClusterStatus()}.</p>
-
- @see JobClient]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.ClusterStatus -->
- <!-- start class org.apache.hadoop.mapred.Counters -->
- <class name="Counters" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Iterable"/>
- <constructor name="Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getGroupNames" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the names of all counter classes.
- @return Set of counter names.]]>
- </doc>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getGroup" return="org.apache.hadoop.mapred.Counters.Group"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the named counter group, or an empty group if there is none
- with the specified name.]]>
- </doc>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Find the counter for the given enum. The same enum will always return the
- same counter.
- @param key the counter key
- @return the matching counter object]]>
- </doc>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Find a counter given the group and the name.
- @param group the name of the group
- @param name the internal name of the counter
- @return the counter for that name]]>
- </doc>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="deprecated, no comment">
- <param name="group" type="java.lang.String"/>
- <param name="id" type="int"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Find a counter by using strings
- @param group the name of the group
- @param id the id of the counter within the group (0 to N-1)
- @param name the internal name of the counter
- @return the counter for that name
- @deprecated]]>
- </doc>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <param name="amount" type="long"/>
- <doc>
- <![CDATA[Increments the specified counter by the specified amount, creating it if
- it didn't already exist.
- @param key identifies a counter
- @param amount amount by which counter is to be incremented]]>
- </doc>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="counter" type="java.lang.String"/>
- <param name="amount" type="long"/>
- <doc>
- <![CDATA[Increments the specified counter by the specified amount, creating it if
- it didn't already exist.
- @param group the name of the group
- @param counter the internal name of the counter
- @param amount amount by which counter is to be incremented]]>
- </doc>
- </method>
- <method name="getCounter" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Returns current value of the specified counter, or 0 if the counter
- does not exist.]]>
- </doc>
- </method>
- <method name="incrAllCounters"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Increments multiple counters by their amounts in another Counters
- instance.
- @param other the other Counters instance]]>
- </doc>
- </method>
- <method name="sum" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.mapred.Counters"/>
- <param name="b" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Convenience method for computing the sum of two sets of counters.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of counters, by summing the number of counters
- in each group.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the set of groups.
- The external format is:
- #groups (groupName group)*
- i.e. the number of groups followed by 0 or more groups, where each
- group is of the form:
- groupDisplayName #counters (false | true counter)*
- where each counter is of the form:
- name (false | true displayName) value]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a set of groups.]]>
- </doc>
- </method>
- <method name="log"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="log" type="org.apache.commons.logging.Log"/>
- <doc>
- <![CDATA[Logs the current counter values.
- @param log The log to use.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return textual representation of the counter values.]]>
- </doc>
- </method>
- <method name="makeCompactString" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert a counters object into a single line that is easy to parse.
- @return the string with "name=value" for each counter and separated by ","]]>
- </doc>
- </method>
- <method name="makeEscapedCompactString" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Represent the counter in a textual format that can be converted back to
- its object form
- @return the string in the following format
- {(groupname)(group-displayname)[(countername)(displayname)(value)][][]}{}{}]]>
- </doc>
- </method>
- <method name="fromEscapedCompactString" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="compactString" type="java.lang.String"/>
- <exception name="ParseException" type="java.text.ParseException"/>
- <doc>
- <![CDATA[Convert a stringified counter representation into a counter object. Note
- that the counter can be recovered if its stringified using
- {@link #makeEscapedCompactString()}.
- @return a Counter]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <field name="MAX_COUNTER_LIMIT" type="int"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[limit on counters]]>
- </doc>
- </field>
- <field name="MAX_GROUP_LIMIT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the max groups allowed]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A set of named counters.
-
- <p><code>Counters</code> represent global counters, defined either by the
- Map-Reduce framework or applications. Each <code>Counter</code> can be of
- any {@link Enum} type.</p>
-
- <p><code>Counters</code> are bunched into {@link Group}s, each comprising of
- counters from a particular <code>Enum</code> class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Counters -->
- <!-- start class org.apache.hadoop.mapred.Counters.Counter -->
- <class name="Counters.Counter" extends="org.apache.hadoop.mapreduce.Counter"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="setDisplayName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newName" type="java.lang.String"/>
- </method>
- <method name="makeEscapedCompactString" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the compact stringified version of the counter in the format
- [(actual-name)(display-name)(value)]]]>
- </doc>
- </method>
- <method name="getCounter" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[What is the current value of this counter?
- @return the current value]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A counter record, comprising its name and value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Counters.Counter -->
- <!-- start class org.apache.hadoop.mapred.Counters.CountersExceededException -->
- <class name="Counters.CountersExceededException" extends="java.lang.RuntimeException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Counters.CountersExceededException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Counter exception thrown when the number of counters exceed
- the limit]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Counters.CountersExceededException -->
- <!-- start class org.apache.hadoop.mapred.Counters.Group -->
- <class name="Counters.Group" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Iterable"/>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns raw name of the group. This is the name of the enum class
- for this group of counters.]]>
- </doc>
- </method>
- <method name="getDisplayName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns localized name of the group. This is the same as getName() by
- default, but different if an appropriate ResourceBundle is found.]]>
- </doc>
- </method>
- <method name="setDisplayName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="displayName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the display name]]>
- </doc>
- </method>
- <method name="makeEscapedCompactString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the compact stringified version of the group in the format
- {(actual-name)(display-name)(value)[][][]} where [] are compact strings for the
- counters within.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- <doc>
- <![CDATA[Checks for (content) equality of Groups]]>
- </doc>
- </method>
- <method name="getCounter" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counterName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the value of the specified counter, or 0 if the counter does
- not exist.]]>
- </doc>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getCounter(String)} instead">
- <param name="id" type="int"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the counter for the given id and create it if it doesn't exist.
- @param id the numeric id of the counter within the group
- @param name the internal counter name
- @return the counter
- @deprecated use {@link #getCounter(String)} instead]]>
- </doc>
- </method>
- <method name="getCounterForName" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the counter for the given name and create it if it doesn't exist.
- @param name the internal counter name
- @return the counter]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of counters in this group.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<code>Group</code> of counters, comprising of counters from a particular
- counter {@link Enum} class.
- <p><code>Group</code>handles localization of the class name and the
- counter names.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Counters.Group -->
- <!-- start class org.apache.hadoop.mapred.DefaultJobHistoryParser -->
- <class name="DefaultJobHistoryParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DefaultJobHistoryParser"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="parseJobTasks"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobHistoryFile" type="java.lang.String"/>
- <param name="job" type="org.apache.hadoop.mapred.JobHistory.JobInfo"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Populates a JobInfo object from the job's history log file.
- @param jobHistoryFile history file for this job.
- @param job a precreated JobInfo object, should be non-null.
- @param fs FileSystem where historyFile is present.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Default parser for job history files. It creates object model from
- job history file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.DefaultJobHistoryParser -->
- <!-- start class org.apache.hadoop.mapred.DefaultTaskController -->
- <class name="DefaultTaskController" extends="org.apache.hadoop.mapred.TaskController"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DefaultTaskController"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="createLogDir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskID" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="isCleanup" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="launchTask" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobId" type="java.lang.String"/>
- <param name="attemptId" type="java.lang.String"/>
- <param name="setup" type="java.util.List"/>
- <param name="jvmArguments" type="java.util.List"/>
- <param name="currentWorkDirectory" type="java.io.File"/>
- <param name="stdout" type="java.lang.String"/>
- <param name="stderr" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create all of the directories for the task and launches the child jvm.
- @param user the user name
- @param attemptId the attempt id
- @throws IOException]]>
- </doc>
- </method>
- <method name="initializeJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- <param name="credentials" type="org.apache.hadoop.fs.Path"/>
- <param name="jobConf" type="org.apache.hadoop.fs.Path"/>
- <param name="taskTracker" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="ttAddr" type="java.net.InetSocketAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[This routine initializes the local file system for running a job.
- Details:
- <ul>
- <li>Copies the credentials file from the TaskTracker's private space to
- the job's private space </li>
- <li>Creates the job work directory and set
- {@link TaskTracker#JOB_LOCAL_DIR} in the configuration</li>
- <li>Downloads the job.jar, unjars it, and updates the configuration to
- reflect the localized path of the job.jar</li>
- <li>Creates a base JobConf in the job's private space</li>
- <li>Sets up the distributed cache</li>
- <li>Sets up the user logs directory for the job</li>
- </ul>
- This method must be invoked in the access control context of the job owner
- user. This is because the distributed cache is also setup here and the
- access to the hdfs files requires authentication tokens in case where
- security is enabled.
- @param user the user in question (the job owner)
- @param jobid the ID of the job in question
- @param credentials the path to the credentials file that the TaskTracker
- downloaded
- @param jobConf the path to the job configuration file that the TaskTracker
- downloaded
- @param taskTracker the connection to the task tracker
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="signalTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="taskPid" type="int"/>
- <param name="signal" type="org.apache.hadoop.util.ProcessTree.Signal"/>
- </method>
- <method name="deleteAsUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="subDir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the user's files under all of the task tracker root directories.
- @param user the user name
- @param subDir the path relative to the user's subdirectory under
- the task tracker root directories.
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteLogAsUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="subDir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the user's files under the userlogs directory.
- @param user the user to work as
- @param subDir the path under the userlogs directory.
- @throws IOException]]>
- </doc>
- </method>
- <method name="truncateLogsAsUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="allAttempts" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocator" type="org.apache.hadoop.fs.LocalDirAllocator"/>
- <param name="localStorage" type="org.apache.hadoop.mapred.TaskTracker.LocalStorage"/>
- </method>
- <doc>
- <![CDATA[The default implementation for controlling tasks.
-
- This class provides an implementation for launching and killing
- tasks that need to be run as the tasktracker itself. Hence,
- many of the initializing or cleanup methods are not required here.
-
- <br/>
-
- NOTE: This class is internal only class and not intended for users!!]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.DefaultTaskController -->
- <!-- start class org.apache.hadoop.mapred.FileAlreadyExistsException -->
- <class name="FileAlreadyExistsException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileAlreadyExistsException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FileAlreadyExistsException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Used when target file already exists for any operation and
- is not configured to be overwritten.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileAlreadyExistsException -->
- <!-- start class org.apache.hadoop.mapred.FileInputFormat -->
- <class name="FileInputFormat" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputFormat"/>
- <constructor name="FileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setMinSplitSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="minSplitSize" type="long"/>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Is the given filename splitable? Usually, true, but if the file is
- stream compressed, it will not be.
-
- <code>FileInputFormat</code> implementations can override this and return
- <code>false</code> to ensure that individual input files are never split-up
- so that {@link Mapper}s process entire files.
-
- @param fs the file system that the file is on
- @param filename the file name to check
- @return is this file splitable?]]>
- </doc>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setInputPathFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="filter" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set a PathFilter to be applied to the input paths for the map-reduce job.
- @param filter the PathFilter class use for filtering the input paths.]]>
- </doc>
- </method>
- <method name="getInputPathFilter" return="org.apache.hadoop.fs.PathFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get a PathFilter instance of the filter set for the input paths.
- @return the PathFilter instance set for the job, NULL if none has been set.]]>
- </doc>
- </method>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List input directories.
- Subclasses may override to, e.g., select only files matching a regular
- expression.
-
- @param job the job to list input paths for
- @return array of FileStatus objects
- @throws IOException if zero items.]]>
- </doc>
- </method>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Splits files returned by {@link #listStatus(JobConf)} when
- they're too big.]]>
- </doc>
- </method>
- <method name="computeSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="goalSize" type="long"/>
- <param name="minSize" type="long"/>
- <param name="blockSize" type="long"/>
- </method>
- <method name="getBlockIndex" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
- <param name="offset" type="long"/>
- </method>
- <method name="setInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="commaSeparatedPaths" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the given comma separated paths as the list of inputs
- for the map-reduce job.
-
- @param conf Configuration of the job
- @param commaSeparatedPaths Comma separated paths to be set as
- the list of inputs for the map-reduce job.]]>
- </doc>
- </method>
- <method name="addInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="commaSeparatedPaths" type="java.lang.String"/>
- <doc>
- <![CDATA[Add the given comma separated paths to the list of inputs for
- the map-reduce job.
-
- @param conf The configuration of the job
- @param commaSeparatedPaths Comma separated paths to be added to
- the list of inputs for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="inputPaths" type="org.apache.hadoop.fs.Path[]"/>
- <doc>
- <![CDATA[Set the array of {@link Path}s as the list of inputs
- for the map-reduce job.
-
- @param conf Configuration of the job.
- @param inputPaths the {@link Path}s of the input directories/files
- for the map-reduce job.]]>
- </doc>
- </method>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Add a {@link Path} to the list of inputs for the map-reduce job.
-
- @param conf The configuration of the job
- @param path {@link Path} to be added to the list of inputs for
- the map-reduce job.]]>
- </doc>
- </method>
- <method name="getInputPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the list of input {@link Path}s for the map-reduce job.
-
- @param conf The configuration of the job
- @return the list of input {@link Path}s for the map-reduce job.]]>
- </doc>
- </method>
- <method name="getSplitHosts" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
- <param name="offset" type="long"/>
- <param name="splitSize" type="long"/>
- <param name="clusterMap" type="org.apache.hadoop.net.NetworkTopology"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This function identifies and returns the hosts that contribute
- most for a given split. For calculating the contribution, rack
- locality is treated on par with host locality, so hosts from racks
- that contribute the most are preferred over hosts on racks that
- contribute less
- @param blkLocations The list of block locations
- @param offset
- @param splitSize
- @return array of hosts that contribute most to this split
- @throws IOException]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A base class for file-based {@link InputFormat}.
-
- <p><code>FileInputFormat</code> is the base class for all file-based
- <code>InputFormat</code>s. This provides a generic implementation of
- {@link #getSplits(JobConf, int)}.
- Subclasses of <code>FileInputFormat</code> can also override the
- {@link #isSplitable(FileSystem, Path)} method to ensure input-files are
- not split-up and are processed as a whole by {@link Mapper}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileInputFormat -->
- <!-- start class org.apache.hadoop.mapred.FileInputFormat.Counter -->
- <class name="FileInputFormat.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.FileInputFormat.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.FileInputFormat.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="BYTES_READ" type="org.apache.hadoop.mapred.FileInputFormat.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileInputFormat.Counter -->
- <!-- start class org.apache.hadoop.mapred.FileOutputCommitter -->
- <class name="FileOutputCommitter" extends="org.apache.hadoop.mapred.OutputCommitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileOutputCommitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cleanupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
- <param name="runState" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the temporary directory, including all of the work directories.
- @param context the job's context
- @param runState final run state of the job, should be
- {@link JobStatus#KILLED} or {@link JobStatus#FAILED}]]>
- </doc>
- </method>
- <method name="setupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="commitTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="abortTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="needsTaskCommit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TEMP_DIR_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Temporary directory name]]>
- </doc>
- </field>
- <field name="SUCCEEDED_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An {@link OutputCommitter} that commits files specified
- in job output directory i.e. ${mapred.output.dir}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileOutputCommitter -->
- <!-- start class org.apache.hadoop.mapred.FileOutputFormat -->
- <class name="FileOutputFormat" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.OutputFormat"/>
- <constructor name="FileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setCompressOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="compress" type="boolean"/>
- <doc>
- <![CDATA[Set whether the output of the job is compressed.
- @param conf the {@link JobConf} to modify
- @param compress should the output of the job be compressed?]]>
- </doc>
- </method>
- <method name="getCompressOutput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Is the job output compressed?
- @param conf the {@link JobConf} to look in
- @return <code>true</code> if the job output should be compressed,
- <code>false</code> otherwise]]>
- </doc>
- </method>
- <method name="setOutputCompressorClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="codecClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link CompressionCodec} to be used to compress job outputs.
- @param conf the {@link JobConf} to modify
- @param codecClass the {@link CompressionCodec} to be used to
- compress the job outputs]]>
- </doc>
- </method>
- <method name="getOutputCompressorClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the {@link CompressionCodec} for compressing the job outputs.
- @param conf the {@link JobConf} to look in
- @param defaultValue the {@link CompressionCodec} to return if not set
- @return the {@link CompressionCodec} to be used to compress the
- job outputs
- @throws IllegalArgumentException if the class was specified, but not found]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.mapred.FileAlreadyExistsException"/>
- <exception name="InvalidJobConfException" type="org.apache.hadoop.mapred.InvalidJobConfException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOutputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="outputDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the {@link Path} of the output directory for the map-reduce job.
- @param conf The configuration of the job.
- @param outputDir the {@link Path} of the output directory for
- the map-reduce job.]]>
- </doc>
- </method>
- <method name="getOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the {@link Path} to the output directory for the map-reduce job.
-
- @return the {@link Path} to the output directory for the map-reduce job.
- @see FileOutputFormat#getWorkOutputPath(JobConf)]]>
- </doc>
- </method>
- <method name="getWorkOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the {@link Path} to the task's temporary output directory
- for the map-reduce job
-
- <h4 id="SideEffectFiles">Tasks' Side-Effect Files</h4>
-
- <p><i>Note:</i> The following is valid only if the {@link OutputCommitter}
- is {@link FileOutputCommitter}. If <code>OutputCommitter</code> is not
- a <code>FileOutputCommitter</code>, the task's temporary output
- directory is same as {@link #getOutputPath(JobConf)} i.e.
- <tt>${mapred.output.dir}$</tt></p>
-
- <p>Some applications need to create/write-to side-files, which differ from
- the actual job-outputs.
-
- <p>In such cases there could be issues with 2 instances of the same TIP
- (running simultaneously e.g. speculative tasks) trying to open/write-to the
- same file (path) on HDFS. Hence the application-writer will have to pick
- unique names per task-attempt (e.g. using the attemptid, say
- <tt>attempt_200709221812_0001_m_000000_0</tt>), not just per TIP.</p>
-
- <p>To get around this the Map-Reduce framework helps the application-writer
- out by maintaining a special
- <tt>${mapred.output.dir}/_temporary/_${taskid}</tt>
- sub-directory for each task-attempt on HDFS where the output of the
- task-attempt goes. On successful completion of the task-attempt the files
- in the <tt>${mapred.output.dir}/_temporary/_${taskid}</tt> (only)
- are <i>promoted</i> to <tt>${mapred.output.dir}</tt>. Of course, the
- framework discards the sub-directory of unsuccessful task-attempts. This
- is completely transparent to the application.</p>
-
- <p>The application-writer can take advantage of this by creating any
- side-files required in <tt>${mapred.work.output.dir}</tt> during execution
- of his reduce-task i.e. via {@link #getWorkOutputPath(JobConf)}, and the
- framework will move them out similarly - thus she doesn't have to pick
- unique paths per task-attempt.</p>
-
- <p><i>Note</i>: the value of <tt>${mapred.work.output.dir}</tt> during
- execution of a particular task-attempt is actually
- <tt>${mapred.output.dir}/_temporary/_{$taskid}</tt>, and this value is
- set by the map-reduce framework. So, just create any side-files in the
- path returned by {@link #getWorkOutputPath(JobConf)} from map/reduce
- task to take advantage of this feature.</p>
-
- <p>The entire discussion holds true for maps of jobs with
- reducer=NONE (i.e. 0 reduces) since output of the map, in that case,
- goes directly to HDFS.</p>
-
- @return the {@link Path} to the task's temporary output directory
- for the map-reduce job.]]>
- </doc>
- </method>
- <method name="getTaskOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Helper function to create the task's temporary output directory and
- return the path to the task's output file.
-
- @param conf job-configuration
- @param name temporary task-output filename
- @return path to the task's temporary output file
- @throws IOException]]>
- </doc>
- </method>
- <method name="getUniqueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Helper function to generate a name that is unique for the task.
- <p>The generated name can be used to create custom files from within the
- different tasks for the job, the names for different tasks will not collide
- with each other.</p>
- <p>The given name is postfixed with the task type, 'm' for maps, 'r' for
- reduces and the task partition number. For example, give a name 'test'
- running on the first map o the job the generated name will be
- 'test-m-00000'.</p>
- @param conf the configuration for the job.
- @param name the name to make unique.
- @return a unique name accross all tasks of the job.]]>
- </doc>
- </method>
- <method name="getPathForCustomFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Helper function to generate a {@link Path} for a file that is unique for
- the task within the job output directory.
- <p>The path can be used to create custom files from within the map and
- reduce tasks. The path name will be unique for each task. The path parent
- will be the job output directory.</p>ls
- <p>This method uses the {@link #getUniqueName} method to make the file name
- unique for the task.</p>
- @param conf the configuration for the job.
- @param name the name for the file.
- @return a unique path accross all tasks of the job.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A base class for {@link OutputFormat}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.FileOutputFormat.Counter -->
- <class name="FileOutputFormat.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.FileOutputFormat.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.FileOutputFormat.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="BYTES_WRITTEN" type="org.apache.hadoop.mapred.FileOutputFormat.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileOutputFormat.Counter -->
- <!-- start class org.apache.hadoop.mapred.FileSplit -->
- <class name="FileSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputSplit"/>
- <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="deprecated, no comment">
- <doc>
- <![CDATA[Constructs a split.
- @deprecated
- @param file the file name
- @param start the position of the first byte in the file to process
- @param length the number of bytes in the file to process]]>
- </doc>
- </constructor>
- <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a split with host information
- @param file the file name
- @param start the position of the first byte in the file to process
- @param length the number of bytes in the file to process
- @param hosts the list of hosts containing the block, possibly null]]>
- </doc>
- </constructor>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The file containing this split's data.]]>
- </doc>
- </method>
- <method name="getStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The position of the first byte in the file to process.]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of bytes in the file to process.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A section of an input file. Returned by {@link
- InputFormat#getSplits(JobConf, int)} and passed to
- {@link InputFormat#getRecordReader(InputSplit,JobConf,Reporter)}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.FileSplit -->
- <!-- start class org.apache.hadoop.mapred.HDFSMonitorThread -->
- <class name="HDFSMonitorThread" extends="java.lang.Thread"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HDFSMonitorThread" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.JobTracker, org.apache.hadoop.fs.FileSystem"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.HDFSMonitorThread -->
- <!-- start class org.apache.hadoop.mapred.ID -->
- <class name="ID" extends="org.apache.hadoop.mapreduce.ID"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ID" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructs an ID object from the given int]]>
- </doc>
- </constructor>
- <constructor name="ID"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A general identifier, which internally stores the id
- as an integer. This is the super class of {@link JobID},
- {@link TaskID} and {@link TaskAttemptID}.
-
- @see JobID
- @see TaskID
- @see TaskAttemptID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.ID -->
- <!-- start interface org.apache.hadoop.mapred.InputFormat -->
- <interface name="InputFormat" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Logically split the set of input files for the job.
-
- <p>Each {@link InputSplit} is then assigned to an individual {@link Mapper}
- for processing.</p>
- <p><i>Note</i>: The split is a <i>logical</i> split of the inputs and the
- input files are not physically split into chunks. For e.g. a split could
- be <i><input-file-path, start, offset></i> tuple.
-
- @param job job configuration.
- @param numSplits the desired number of splits, a hint.
- @return an array of {@link InputSplit}s for the job.]]>
- </doc>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the {@link RecordReader} for the given {@link InputSplit}.
- <p>It is the responsibility of the <code>RecordReader</code> to respect
- record boundaries while processing the logical split to present a
- record-oriented view to the individual task.</p>
-
- @param split the {@link InputSplit}
- @param job the job that this split belongs to
- @return a {@link RecordReader}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>InputFormat</code> describes the input-specification for a
- Map-Reduce job.
-
- <p>The Map-Reduce framework relies on the <code>InputFormat</code> of the
- job to:<p>
- <ol>
- <li>
- Validate the input-specification of the job.
- <li>
- Split-up the input file(s) into logical {@link InputSplit}s, each of
- which is then assigned to an individual {@link Mapper}.
- </li>
- <li>
- Provide the {@link RecordReader} implementation to be used to glean
- input records from the logical <code>InputSplit</code> for processing by
- the {@link Mapper}.
- </li>
- </ol>
-
- <p>The default behavior of file-based {@link InputFormat}s, typically
- sub-classes of {@link FileInputFormat}, is to split the
- input into <i>logical</i> {@link InputSplit}s based on the total size, in
- bytes, of the input files. However, the {@link FileSystem} blocksize of
- the input files is treated as an upper bound for input splits. A lower bound
- on the split size can be set via
- <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
- mapred.min.split.size</a>.</p>
-
- <p>Clearly, logical splits based on input-size is insufficient for many
- applications since record boundaries are to respected. In such cases, the
- application has to also implement a {@link RecordReader} on whom lies the
- responsibilty to respect record-boundaries and present a record-oriented
- view of the logical <code>InputSplit</code> to the individual task.
- @see InputSplit
- @see RecordReader
- @see JobClient
- @see FileInputFormat]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.InputFormat -->
- <!-- start interface org.apache.hadoop.mapred.InputSplit -->
- <interface name="InputSplit" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the total number of bytes in the data of the <code>InputSplit</code>.
-
- @return the number of bytes in the input split.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the list of hostnames where the input split is located.
-
- @return list of hostnames where data of the <code>InputSplit</code> is
- located as an array of <code>String</code>s.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>InputSplit</code> represents the data to be processed by an
- individual {@link Mapper}.
- <p>Typically, it presents a byte-oriented view on the input and is the
- responsibility of {@link RecordReader} of the job to process this and present
- a record-oriented view.
-
- @see InputFormat
- @see RecordReader]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.InputSplit -->
- <!-- start class org.apache.hadoop.mapred.InvalidFileTypeException -->
- <class name="InvalidFileTypeException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidFileTypeException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidFileTypeException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Used when file type differs from the desired file type. like
- getting a file when a directory is expected. Or a wrong file type.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.InvalidFileTypeException -->
- <!-- start class org.apache.hadoop.mapred.InvalidInputException -->
- <class name="InvalidInputException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidInputException" type="java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the exception with the given list.
- @param probs the list of problems to report. this list is not copied.]]>
- </doc>
- </constructor>
- <method name="getProblems" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the complete list of the problems reported.
- @return the list of problems, which must not be modified]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a summary message of the problems found.
- @return the concatenated messages from all of the problems.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class wraps a list of problems with the input, so that the user
- can get a list of problems together instead of finding and fixing them one
- by one.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.InvalidInputException -->
- <!-- start class org.apache.hadoop.mapred.InvalidJobConfException -->
- <class name="InvalidJobConfException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidJobConfException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidJobConfException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidJobConfException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidJobConfException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when jobconf misses some mendatory attributes
- or value of some attributes is invalid.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.InvalidJobConfException -->
- <!-- start class org.apache.hadoop.mapred.IsolationRunner -->
- <class name="IsolationRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IsolationRunner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Run a single task.
- @param args the first argument is the task directory]]>
- </doc>
- </method>
- <doc>
- <![CDATA[IsolationRunner is intended to facilitate debugging by re-running a specific
- task, given left-over task files for a (typically failed) past job.
- Currently, it is limited to re-running map tasks.
- Users may coerce MapReduce to keep task files around by setting
- keep.failed.task.files. See mapred_tutorial.xml for more documentation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.IsolationRunner -->
- <!-- start class org.apache.hadoop.mapred.JobClient -->
- <class name="JobClient" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.MRConstants"/>
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="JobClient"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job client.]]>
- </doc>
- </constructor>
- <constructor name="JobClient" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Build a job client with the given {@link JobConf}, and connect to the
- default {@link JobTracker}.
-
- @param conf the job configuration.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="JobClient" type="java.net.InetSocketAddress, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Build a job client, connect to the indicated job tracker.
-
- @param jobTrackAddr the job tracker to connect to.
- @param conf configuration.]]>
- </doc>
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Connect to the default {@link JobTracker}.
- @param conf the job configuration.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the <code>JobClient</code>.]]>
- </doc>
- </method>
- <method name="getFs" return="org.apache.hadoop.fs.FileSystem"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a filesystem handle. We need this to prepare jobs
- for submission to the MapReduce system.
-
- @return the filesystem handle.
- @throws IOException]]>
- </doc>
- </method>
- <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobFile" type="java.lang.String"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="InvalidJobConfException" type="org.apache.hadoop.mapred.InvalidJobConfException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Submit a job to the MR system.
-
- This returns a handle to the {@link RunningJob} which can be used to track
- the running-job.
-
- @param jobFile the job configuration.
- @return a handle to the {@link RunningJob} which can be used to track the
- running-job.
- @throws FileNotFoundException
- @throws InvalidJobConfException
- @throws IOException]]>
- </doc>
- </method>
- <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Submit a job to the MR system.
- This returns a handle to the {@link RunningJob} which can be used to track
- the running-job.
-
- @param job the job configuration.
- @return a handle to the {@link RunningJob} which can be used to track the
- running-job.
- @throws FileNotFoundException
- @throws IOException]]>
- </doc>
- </method>
- <method name="submitJobInternal" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Internal method for submitting jobs to the system.
- @param job the configuration to submit
- @return a proxy object for the running job
- @throws FileNotFoundException
- @throws ClassNotFoundException
- @throws InterruptedException
- @throws IOException]]>
- </doc>
- </method>
- <method name="isJobDirValid" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobDirPath" type="org.apache.hadoop.fs.Path"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Checks if the job directory is clean and has all the required components
- for (re) starting the job]]>
- </doc>
- </method>
- <method name="getJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an {@link RunningJob} object to track an ongoing job. Returns
- null if the id does not correspond to any known job.
-
- @param jobid the jobid of the job.
- @return the {@link RunningJob} handle to track the job, null if the
- <code>jobid</code> doesn't correspond to any known job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Applications should rather use {@link #getJob(JobID)}.">
- <param name="jobid" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Applications should rather use {@link #getJob(JobID)}.]]>
- </doc>
- </method>
- <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the information of the current state of the map tasks of a job.
-
- @param jobId the job to query.
- @return the list of all of the map tips.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Applications should rather use {@link #getMapTaskReports(JobID)}">
- <param name="jobId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Applications should rather use {@link #getMapTaskReports(JobID)}]]>
- </doc>
- </method>
- <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the information of the current state of the reduce tasks of a job.
-
- @param jobId the job to query.
- @return the list of all of the reduce tips.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCleanupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the information of the current state of the cleanup tasks of a job.
-
- @param jobId the job to query.
- @return the list of all of the cleanup tips.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getSetupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the information of the current state of the setup tasks of a job.
-
- @param jobId the job to query.
- @return the list of all of the setup tips.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Applications should rather use {@link #getReduceTaskReports(JobID)}">
- <param name="jobId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Applications should rather use {@link #getReduceTaskReports(JobID)}]]>
- </doc>
- </method>
- <method name="displayTasks"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="type" type="java.lang.String"/>
- <param name="state" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Display the information about a job's tasks, of a particular type and
- in a particular state
-
- @param jobId the ID of the job
- @param type the type of the task (map/reduce/setup/cleanup)
- @param state the state of the task
- (pending/running/completed/failed/killed)]]>
- </doc>
- </method>
- <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get status information about the Map-Reduce cluster.
-
- @return the status information about the Map-Reduce cluster as an object
- of {@link ClusterStatus}.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="detailed" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get status information about the Map-Reduce cluster.
-
- @param detailed if true then get a detailed status including the
- tracker names and memory usage of the JobTracker
- @return the status information about the Map-Reduce cluster as an object
- of {@link ClusterStatus}.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getStagingAreaDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Grab the jobtracker's view of the staging directory path where
- job-specific files will be placed.
-
- @return the staging directory where job-specific files are to be placed.]]>
- </doc>
- </method>
- <method name="jobsToComplete" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the jobs that are not completed and not failed.
-
- @return array of {@link JobStatus} for the running/to-be-run jobs.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getAllJobs" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the jobs that are submitted.
-
- @return array of {@link JobStatus} for the submitted jobs.
- @throws IOException]]>
- </doc>
- </method>
- <method name="runJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Utility that submits a job, then polls for progress until the job is
- complete.
-
- @param job the job configuration.
- @throws IOException if the job fails]]>
- </doc>
- </method>
- <method name="monitorAndPrintJob" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="job" type="org.apache.hadoop.mapred.RunningJob"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Monitor a job and print status in real-time as progress is made and tasks
- fail.
- @param conf the job's configuration
- @param job the job to track
- @return true if the job succeeded
- @throws IOException if communication to the JobTracker fails]]>
- </doc>
- </method>
- <method name="setTaskOutputFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"/>
- <doc>
- <![CDATA[Sets the output filter for tasks. only those tasks are printed whose
- output matches the filter.
- @param newValue task filter.]]>
- </doc>
- </method>
- <method name="getTaskOutputFilter" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the task output filter out of the JobConf.
-
- @param job the JobConf to examine.
- @return the filter level.]]>
- </doc>
- </method>
- <method name="setTaskOutputFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="newValue" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"/>
- <doc>
- <![CDATA[Modify the JobConf to set the task output filter.
-
- @param job the JobConf to modify.
- @param newValue the value to set.]]>
- </doc>
- </method>
- <method name="getTaskOutputFilter" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns task output filter.
- @return task filter.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="getDefaultMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get status information about the max available Maps in the cluster.
-
- @return the max available Maps in the cluster
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDefaultReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get status information about the max available Reduces in the cluster.
-
- @return the max available Reduces in the cluster
- @throws IOException]]>
- </doc>
- </method>
- <method name="getSystemDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Grab the jobtracker system directory path where job-specific files are to be placed.
-
- @return the system directory where job-specific files are to be placed.]]>
- </doc>
- </method>
- <method name="getQueues" return="org.apache.hadoop.mapred.JobQueueInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an array of queue information objects about all the Job Queues
- configured.
-
- @return Array of JobQueueInfo objects
- @throws IOException]]>
- </doc>
- </method>
- <method name="getJobsFromQueue" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets all the jobs which were added to particular Job Queue
-
- @param queueName name of the Job Queue
- @return Array of jobs present in the job queue
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueInfo" return="org.apache.hadoop.mapred.JobQueueInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the queue information associated to a particular Job Queue
-
- @param queueName name of the job queue.
- @return Queue information associated to particular queue.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueAclsForCurrentUser" return="org.apache.hadoop.mapred.QueueAclsInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the Queue ACLs for current user
- @return array of QueueAclsInfo object for current user.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew a delegation token
- @param token the token to renew
- @return the new expiration time
- @throws InvalidToken
- @throws IOException]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Cancel a delegation token from the JobTracker
- @param token the token to cancel
- @throws IOException]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="MAPREDUCE_CLIENT_RETRY_POLICY_ENABLED_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPREDUCE_CLIENT_RETRY_POLICY_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPREDUCE_CLIENT_RETRY_POLICY_SPEC_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPREDUCE_CLIENT_RETRY_POLICY_SPEC_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<code>JobClient</code> is the primary interface for the user-job to interact
- with the {@link JobTracker}.
-
- <code>JobClient</code> provides facilities to submit jobs, track their
- progress, access component-tasks' reports/logs, get the Map-Reduce cluster
- status information etc.
-
- <p>The job submission process involves:
- <ol>
- <li>
- Checking the input and output specifications of the job.
- </li>
- <li>
- Computing the {@link InputSplit}s for the job.
- </li>
- <li>
- Setup the requisite accounting information for the {@link DistributedCache}
- of the job, if necessary.
- </li>
- <li>
- Copying the job's jar and configuration to the map-reduce system directory
- on the distributed file-system.
- </li>
- <li>
- Submitting the job to the <code>JobTracker</code> and optionally monitoring
- it's status.
- </li>
- </ol></p>
-
- Normally the user creates the application, describes various facets of the
- job via {@link JobConf} and then uses the <code>JobClient</code> to submit
- the job and monitor its progress.
-
- <p>Here is an example on how to use <code>JobClient</code>:</p>
- <p><blockquote><pre>
- // Create a new JobConf
- JobConf job = new JobConf(new Configuration(), MyJob.class);
-
- // Specify various job-specific parameters
- job.setJobName("myjob");
-
- job.setInputPath(new Path("in"));
- job.setOutputPath(new Path("out"));
-
- job.setMapperClass(MyJob.MyMapper.class);
- job.setReducerClass(MyJob.MyReducer.class);
- // Submit the job, then poll for progress until the job is complete
- JobClient.runJob(job);
- </pre></blockquote></p>
-
- <h4 id="JobControl">Job Control</h4>
-
- <p>At times clients would chain map-reduce jobs to accomplish complex tasks
- which cannot be done via a single map-reduce job. This is fairly easy since
- the output of the job, typically, goes to distributed file-system and that
- can be used as the input for the next job.</p>
-
- <p>However, this also means that the onus on ensuring jobs are complete
- (success/failure) lies squarely on the clients. In such situations the
- various job-control options are:
- <ol>
- <li>
- {@link #runJob(JobConf)} : submits the job and returns only after
- the job has completed.
- </li>
- <li>
- {@link #submitJob(JobConf)} : only submits the job, then poll the
- returned handle to the {@link RunningJob} to query status and make
- scheduling decisions.
- </li>
- <li>
- {@link JobConf#setJobEndNotificationURI(String)} : setup a notification
- on job-completion, thus avoiding polling.
- </li>
- </ol></p>
-
- @see JobConf
- @see ClusterStatus
- @see Tool
- @see DistributedCache]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobClient -->
- <!-- start class org.apache.hadoop.mapred.JobClient.Renewer -->
- <class name="JobClient.Renewer" extends="org.apache.hadoop.security.token.TokenRenewer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobClient.Renewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="handleKind" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="kind" type="org.apache.hadoop.io.Text"/>
- </method>
- <method name="renew" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="cancel"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="isManaged" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobClient.Renewer -->
- <!-- start class org.apache.hadoop.mapred.JobClient.TaskStatusFilter -->
- <class name="JobClient.TaskStatusFilter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="NONE" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUCCEEDED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ALL" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobClient.TaskStatusFilter -->
- <!-- start class org.apache.hadoop.mapred.JobConf -->
- <class name="JobConf" extends="org.apache.hadoop.conf.Configuration"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce job configuration.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce job configuration.
-
- @param exampleClass a class whose containing jar is used as the job's jar.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce job configuration.
-
- @param conf a Configuration whose settings will be inherited.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="org.apache.hadoop.conf.Configuration, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce job configuration.
-
- @param conf a Configuration whose settings will be inherited.
- @param exampleClass a class whose containing jar is used as the job's jar.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce configuration.
- @param config a Configuration-format XML job description file.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a map/reduce configuration.
- @param config a Configuration-format XML job description file.]]>
- </doc>
- </constructor>
- <constructor name="JobConf" type="boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A new map/reduce configuration where the behavior of reading from the
- default resources can be turned off.
- <p/>
- If the parameter {@code loadDefaults} is false, the new instance
- will not load resources from the default files.
- @param loadDefaults specifies whether to load from the default files]]>
- </doc>
- </constructor>
- <method name="getCredentials" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get credentials for the job.
- @return credentials for the job]]>
- </doc>
- </method>
- <method name="getJar" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user jar for the map-reduce job.
-
- @return the user jar for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setJar"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jar" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user jar for the map-reduce job.
-
- @param jar the user jar for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setJarByClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the job's jar file by finding an example class location.
-
- @param cls the example class.]]>
- </doc>
- </method>
- <method name="getLocalDirs" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteLocalFiles"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deleteLocalFiles"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="subdir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLocalPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathString" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructs a local file name. Files are distributed among configured
- local directories.]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reported username for this job.
-
- @return the username]]>
- </doc>
- </method>
- <method name="setUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the reported username for this job.
-
- @param user the username for this job.]]>
- </doc>
- </method>
- <method name="setKeepFailedTaskFiles"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keep" type="boolean"/>
- <doc>
- <![CDATA[Set whether the framework should keep the intermediate files for
- failed tasks.
-
- @param keep <code>true</code> if framework should keep the intermediate files
- for failed tasks, <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="getKeepFailedTaskFiles" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should the temporary files for failed tasks be kept?
-
- @return should the files be kept?]]>
- </doc>
- </method>
- <method name="setKeepTaskFilesPattern"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set a regular expression for task names that should be kept.
- The regular expression ".*_m_000123_0" would keep the files
- for the first instance of map 123 that ran.
-
- @param pattern the java.util.regex.Pattern to match against the
- task names.]]>
- </doc>
- </method>
- <method name="getKeepTaskFilesPattern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the regular expression that is matched against the task names
- to see if we need to keep the files.
-
- @return the pattern as a string, if it was set, othewise null.]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the current working directory for the default file system.
-
- @param dir the new current working directory.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current working directory for the default file system.
-
- @return the directory name.]]>
- </doc>
- </method>
- <method name="setNumTasksToExecutePerJvm"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numTasks" type="int"/>
- <doc>
- <![CDATA[Sets the number of tasks that a spawned task JVM should run
- before it exits
- @param numTasks the number of tasks to execute; defaults to 1;
- -1 signifies no limit]]>
- </doc>
- </method>
- <method name="getNumTasksToExecutePerJvm" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of tasks that a spawned JVM should execute]]>
- </doc>
- </method>
- <method name="getInputFormat" return="org.apache.hadoop.mapred.InputFormat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link InputFormat} implementation for the map-reduce job,
- defaults to {@link TextInputFormat} if not specified explicity.
-
- @return the {@link InputFormat} implementation for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setInputFormat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link InputFormat} implementation for the map-reduce job.
-
- @param theClass the {@link InputFormat} implementation for the map-reduce
- job.]]>
- </doc>
- </method>
- <method name="getOutputFormat" return="org.apache.hadoop.mapred.OutputFormat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link OutputFormat} implementation for the map-reduce job,
- defaults to {@link TextOutputFormat} if not specified explicity.
-
- @return the {@link OutputFormat} implementation for the map-reduce job.]]>
- </doc>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapred.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link OutputCommitter} implementation for the map-reduce job,
- defaults to {@link FileOutputCommitter} if not specified explicitly.
-
- @return the {@link OutputCommitter} implementation for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setOutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link OutputCommitter} implementation for the map-reduce job.
-
- @param theClass the {@link OutputCommitter} implementation for the map-reduce
- job.]]>
- </doc>
- </method>
- <method name="setOutputFormat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link OutputFormat} implementation for the map-reduce job.
-
- @param theClass the {@link OutputFormat} implementation for the map-reduce
- job.]]>
- </doc>
- </method>
- <method name="setCompressMapOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="compress" type="boolean"/>
- <doc>
- <![CDATA[Should the map outputs be compressed before transfer?
- Uses the SequenceFile compression.
-
- @param compress should the map outputs be compressed?]]>
- </doc>
- </method>
- <method name="getCompressMapOutput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Are the outputs of the maps be compressed?
-
- @return <code>true</code> if the outputs of the maps are to be compressed,
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setMapOutputCompressorClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="codecClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the given class as the {@link CompressionCodec} for the map outputs.
-
- @param codecClass the {@link CompressionCodec} class that will compress
- the map outputs.]]>
- </doc>
- </method>
- <method name="getMapOutputCompressorClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultValue" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the {@link CompressionCodec} for compressing the map outputs.
-
- @param defaultValue the {@link CompressionCodec} to return if not set
- @return the {@link CompressionCodec} class that should be used to compress the
- map outputs.
- @throws IllegalArgumentException if the class was specified, but not found]]>
- </doc>
- </method>
- <method name="getMapOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the key class for the map output data. If it is not set, use the
- (final) output key class. This allows the map output key class to be
- different than the final output key class.
-
- @return the map output key class.]]>
- </doc>
- </method>
- <method name="setMapOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the key class for the map output data. This allows the user to
- specify the map output key class to be different than the final output
- value class.
-
- @param theClass the map output key class.]]>
- </doc>
- </method>
- <method name="getMapOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value class for the map output data. If it is not set, use the
- (final) output value class This allows the map output value class to be
- different than the final output value class.
-
- @return the map output value class.]]>
- </doc>
- </method>
- <method name="setMapOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value class for the map output data. This allows the user to
- specify the map output value class to be different than the final output
- value class.
-
- @param theClass the map output value class.]]>
- </doc>
- </method>
- <method name="getOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the key class for the job output data.
-
- @return the key class for the job output data.]]>
- </doc>
- </method>
- <method name="setOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the key class for the job output data.
-
- @param theClass the key class for the job output data.]]>
- </doc>
- </method>
- <method name="getOutputKeyComparator" return="org.apache.hadoop.io.RawComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link RawComparator} comparator used to compare keys.
-
- @return the {@link RawComparator} comparator used to compare keys.]]>
- </doc>
- </method>
- <method name="setOutputKeyComparatorClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link RawComparator} comparator used to compare keys.
-
- @param theClass the {@link RawComparator} comparator used to
- compare keys.
- @see #setOutputValueGroupingComparator(Class)]]>
- </doc>
- </method>
- <method name="setKeyFieldComparatorOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keySpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the {@link KeyFieldBasedComparator} options used to compare keys.
-
- @param keySpec the key specification of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field). opts are ordering options. The supported options
- are:
- -n, (Sort numerically)
- -r, (Reverse the result of comparison)]]>
- </doc>
- </method>
- <method name="getKeyFieldComparatorOption" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link KeyFieldBasedComparator} options]]>
- </doc>
- </method>
- <method name="setKeyFieldPartitionerOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keySpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the {@link KeyFieldBasedPartitioner} options used for
- {@link Partitioner}
-
- @param keySpec the key specification of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field).]]>
- </doc>
- </method>
- <method name="getKeyFieldPartitionerOption" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link KeyFieldBasedPartitioner} options]]>
- </doc>
- </method>
- <method name="getOutputValueGroupingComparator" return="org.apache.hadoop.io.RawComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user defined {@link WritableComparable} comparator for
- grouping keys of inputs to the reduce.
-
- @return comparator set by the user for grouping values.
- @see #setOutputValueGroupingComparator(Class) for details.]]>
- </doc>
- </method>
- <method name="setOutputValueGroupingComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the user defined {@link RawComparator} comparator for
- grouping keys in the input to the reduce.
-
- <p>This comparator should be provided if the equivalence rules for keys
- for sorting the intermediates are different from those for grouping keys
- before each call to
- {@link Reducer#reduce(Object, java.util.Iterator, OutputCollector, Reporter)}.</p>
-
- <p>For key-value pairs (K1,V1) and (K2,V2), the values (V1, V2) are passed
- in a single call to the reduce function if K1 and K2 compare as equal.</p>
-
- <p>Since {@link #setOutputKeyComparatorClass(Class)} can be used to control
- how keys are sorted, this can be used in conjunction to simulate
- <i>secondary sort on values</i>.</p>
-
- <p><i>Note</i>: This is not a guarantee of the reduce sort being
- <i>stable</i> in any sense. (In any case, with the order of available
- map-outputs to the reduce being non-deterministic, it wouldn't make
- that much sense.)</p>
-
- @param theClass the comparator class to be used for grouping keys.
- It should implement <code>RawComparator</code>.
- @see #setOutputKeyComparatorClass(Class)]]>
- </doc>
- </method>
- <method name="getUseNewMapper" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should the framework use the new context-object code for running
- the mapper?
- @return true, if the new api should be used]]>
- </doc>
- </method>
- <method name="setUseNewMapper"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="boolean"/>
- <doc>
- <![CDATA[Set whether the framework should use the new api for the mapper.
- This is the default for jobs submitted with the new Job api.
- @param flag true, if the new api should be used]]>
- </doc>
- </method>
- <method name="getUseNewReducer" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should the framework use the new context-object code for running
- the reducer?
- @return true, if the new api should be used]]>
- </doc>
- </method>
- <method name="setUseNewReducer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flag" type="boolean"/>
- <doc>
- <![CDATA[Set whether the framework should use the new api for the reducer.
- This is the default for jobs submitted with the new Job api.
- @param flag true, if the new api should be used]]>
- </doc>
- </method>
- <method name="getOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value class for job outputs.
-
- @return the value class for job outputs.]]>
- </doc>
- </method>
- <method name="setOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value class for job outputs.
-
- @param theClass the value class for job outputs.]]>
- </doc>
- </method>
- <method name="getMapperClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Mapper} class for the job.
-
- @return the {@link Mapper} class for the job.]]>
- </doc>
- </method>
- <method name="setMapperClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link Mapper} class for the job.
-
- @param theClass the {@link Mapper} class for the job.]]>
- </doc>
- </method>
- <method name="getMapRunnerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link MapRunnable} class for the job.
-
- @return the {@link MapRunnable} class for the job.]]>
- </doc>
- </method>
- <method name="setMapRunnerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Expert: Set the {@link MapRunnable} class for the job.
-
- Typically used to exert greater control on {@link Mapper}s.
-
- @param theClass the {@link MapRunnable} class for the job.]]>
- </doc>
- </method>
- <method name="getPartitionerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Partitioner} used to partition {@link Mapper}-outputs
- to be sent to the {@link Reducer}s.
-
- @return the {@link Partitioner} used to partition map-outputs.]]>
- </doc>
- </method>
- <method name="setPartitionerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link Partitioner} class used to partition
- {@link Mapper}-outputs to be sent to the {@link Reducer}s.
-
- @param theClass the {@link Partitioner} used to partition map-outputs.]]>
- </doc>
- </method>
- <method name="getReducerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Reducer} class for the job.
-
- @return the {@link Reducer} class for the job.]]>
- </doc>
- </method>
- <method name="setReducerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link Reducer} class for the job.
-
- @param theClass the {@link Reducer} class for the job.]]>
- </doc>
- </method>
- <method name="getCombinerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-defined <i>combiner</i> class used to combine map-outputs
- before being sent to the reducers. Typically the combiner is same as the
- the {@link Reducer} for the job i.e. {@link #getReducerClass()}.
-
- @return the user-defined combiner class used to combine map-outputs.]]>
- </doc>
- </method>
- <method name="setCombinerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the user-defined <i>combiner</i> class used to combine map-outputs
- before being sent to the reducers.
-
- <p>The combiner is an application-specified aggregation operation, which
- can help cut down the amount of data transferred between the
- {@link Mapper} and the {@link Reducer}, leading to better performance.</p>
-
- <p>The framework may invoke the combiner 0, 1, or multiple times, in both
- the mapper and reducer tasks. In general, the combiner is called as the
- sort/merge result is written to disk. The combiner must:
- <ul>
- <li> be side-effect free</li>
- <li> have the same input and output key types and the same input and
- output value types</li>
- </ul></p>
-
- <p>Typically the combiner is same as the <code>Reducer</code> for the
- job i.e. {@link #setReducerClass(Class)}.</p>
-
- @param theClass the user-defined combiner class used to combine
- map-outputs.]]>
- </doc>
- </method>
- <method name="getSpeculativeExecution" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should speculative execution be used for this job?
- Defaults to <code>true</code>.
-
- @return <code>true</code> if speculative execution be used for this job,
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on, else <code>false</code>.]]>
- </doc>
- </method>
- <method name="getMapSpeculativeExecution" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should speculative execution be used for this job for map tasks?
- Defaults to <code>true</code>.
-
- @return <code>true</code> if speculative execution be
- used for this job for map tasks,
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setMapSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job for map tasks.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on for map tasks,
- else <code>false</code>.]]>
- </doc>
- </method>
- <method name="getReduceSpeculativeExecution" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should speculative execution be used for this job for reduce tasks?
- Defaults to <code>true</code>.
-
- @return <code>true</code> if speculative execution be used
- for reduce tasks for this job,
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setReduceSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job for reduce tasks.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on for reduce tasks,
- else <code>false</code>.]]>
- </doc>
- </method>
- <method name="getNumMapTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get configured the number of reduce tasks for this job.
- Defaults to <code>1</code>.
-
- @return the number of reduce tasks for this job.]]>
- </doc>
- </method>
- <method name="setNumMapTasks"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Set the number of map tasks for this job.
-
- <p><i>Note</i>: This is only a <i>hint</i> to the framework. The actual
- number of spawned map tasks depends on the number of {@link InputSplit}s
- generated by the job's {@link InputFormat#getSplits(JobConf, int)}.
-
- A custom {@link InputFormat} is typically used to accurately control
- the number of map tasks for the job.</p>
-
- <h4 id="NoOfMaps">How many maps?</h4>
-
- <p>The number of maps is usually driven by the total size of the inputs
- i.e. total number of blocks of the input files.</p>
-
- <p>The right level of parallelism for maps seems to be around 10-100 maps
- per-node, although it has been set up to 300 or so for very cpu-light map
- tasks. Task setup takes awhile, so it is best if the maps take at least a
- minute to execute.</p>
-
- <p>The default behavior of file-based {@link InputFormat}s is to split the
- input into <i>logical</i> {@link InputSplit}s based on the total size, in
- bytes, of input files. However, the {@link FileSystem} blocksize of the
- input files is treated as an upper bound for input splits. A lower bound
- on the split size can be set via
- <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
- mapred.min.split.size</a>.</p>
-
- <p>Thus, if you expect 10TB of input data and have a blocksize of 128MB,
- you'll end up with 82,000 maps, unless {@link #setNumMapTasks(int)} is
- used to set it even higher.</p>
-
- @param n the number of map tasks for this job.
- @see InputFormat#getSplits(JobConf, int)
- @see FileInputFormat
- @see FileSystem#getDefaultBlockSize()
- @see FileStatus#getBlockSize()]]>
- </doc>
- </method>
- <method name="getNumReduceTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get configured the number of reduce tasks for this job. Defaults to
- <code>1</code>.
-
- @return the number of reduce tasks for this job.]]>
- </doc>
- </method>
- <method name="setNumReduceTasks"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Set the requisite number of reduce tasks for this job.
-
- <h4 id="NoOfReduces">How many reduces?</h4>
-
- <p>The right number of reduces seems to be <code>0.95</code> or
- <code>1.75</code> multiplied by (<<i>no. of nodes</i>> *
- <a href="{@docRoot}/../mapred-default.html#mapred.tasktracker.reduce.tasks.maximum">
- mapred.tasktracker.reduce.tasks.maximum</a>).
- </p>
-
- <p>With <code>0.95</code> all of the reduces can launch immediately and
- start transfering map outputs as the maps finish. With <code>1.75</code>
- the faster nodes will finish their first round of reduces and launch a
- second wave of reduces doing a much better job of load balancing.</p>
-
- <p>Increasing the number of reduces increases the framework overhead, but
- increases load balancing and lowers the cost of failures.</p>
-
- <p>The scaling factors above are slightly less than whole numbers to
- reserve a few reduce slots in the framework for speculative-tasks, failures
- etc.</p>
- <h4 id="ReducerNone">Reducer NONE</h4>
-
- <p>It is legal to set the number of reduce-tasks to <code>zero</code>.</p>
-
- <p>In this case the output of the map-tasks directly go to distributed
- file-system, to the path set by
- {@link FileOutputFormat#setOutputPath(JobConf, Path)}. Also, the
- framework doesn't sort the map-outputs before writing it out to HDFS.</p>
-
- @param n the number of reduce tasks for this job.]]>
- </doc>
- </method>
- <method name="getMaxMapAttempts" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configured number of maximum attempts that will be made to run a
- map task, as specified by the <code>mapred.map.max.attempts</code>
- property. If this property is not already set, the default is 4 attempts.
-
- @return the max number of attempts per map task.]]>
- </doc>
- </method>
- <method name="setMaxMapAttempts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Expert: Set the number of maximum attempts that will be made to run a
- map task.
-
- @param n the number of attempts per map task.]]>
- </doc>
- </method>
- <method name="getMaxReduceAttempts" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configured number of maximum attempts that will be made to run a
- reduce task, as specified by the <code>mapred.reduce.max.attempts</code>
- property. If this property is not already set, the default is 4 attempts.
-
- @return the max number of attempts per reduce task.]]>
- </doc>
- </method>
- <method name="setMaxReduceAttempts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="int"/>
- <doc>
- <![CDATA[Expert: Set the number of maximum attempts that will be made to run a
- reduce task.
-
- @param n the number of attempts per reduce task.]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-specified job name. This is only used to identify the
- job to the user.
-
- @return the job's name, defaulting to "".]]>
- </doc>
- </method>
- <method name="setJobName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user-specified job name.
-
- @param name the job's new name.]]>
- </doc>
- </method>
- <method name="getSessionId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-specified session identifier. The default is the empty string.
- The session identifier is used to tag metric data that is reported to some
- performance metrics system via the org.apache.hadoop.metrics API. The
- session identifier is intended, in particular, for use by Hadoop-On-Demand
- (HOD) which allocates a virtual Hadoop cluster dynamically and transiently.
- HOD will set the session identifier by modifying the mapred-site.xml file
- before starting the cluster.
- When not running under HOD, this identifer is expected to remain set to
- the empty string.
- @return the session identifier, defaulting to "".]]>
- </doc>
- </method>
- <method name="setSessionId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sessionId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user-specified session identifier.
- @param sessionId the new session id.]]>
- </doc>
- </method>
- <method name="setMaxTaskFailuresPerTracker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="noFailures" type="int"/>
- <doc>
- <![CDATA[Set the maximum no. of failures of a given job per tasktracker.
- If the no. of task failures exceeds <code>noFailures</code>, the
- tasktracker is <i>blacklisted</i> for this job.
-
- @param noFailures maximum no. of failures of a given job per tasktracker.]]>
- </doc>
- </method>
- <method name="getMaxTaskFailuresPerTracker" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Expert: Get the maximum no. of failures of a given job per tasktracker.
- If the no. of task failures exceeds this, the tasktracker is
- <i>blacklisted</i> for this job.
-
- @return the maximum no. of failures of a given job per tasktracker.]]>
- </doc>
- </method>
- <method name="getMaxMapTaskFailuresPercent" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum percentage of map tasks that can fail without
- the job being aborted.
-
- Each map task is executed a minimum of {@link #getMaxMapAttempts()}
- attempts before being declared as <i>failed</i>.
-
- Defaults to <code>zero</code>, i.e. <i>any</i> failed map-task results in
- the job being declared as {@link JobStatus#FAILED}.
-
- @return the maximum percentage of map tasks that can fail without
- the job being aborted.]]>
- </doc>
- </method>
- <method name="setMaxMapTaskFailuresPercent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="percent" type="int"/>
- <doc>
- <![CDATA[Expert: Set the maximum percentage of map tasks that can fail without the
- job being aborted.
-
- Each map task is executed a minimum of {@link #getMaxMapAttempts} attempts
- before being declared as <i>failed</i>.
-
- @param percent the maximum percentage of map tasks that can fail without
- the job being aborted.]]>
- </doc>
- </method>
- <method name="getMaxReduceTaskFailuresPercent" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum percentage of reduce tasks that can fail without
- the job being aborted.
-
- Each reduce task is executed a minimum of {@link #getMaxReduceAttempts()}
- attempts before being declared as <i>failed</i>.
-
- Defaults to <code>zero</code>, i.e. <i>any</i> failed reduce-task results
- in the job being declared as {@link JobStatus#FAILED}.
-
- @return the maximum percentage of reduce tasks that can fail without
- the job being aborted.]]>
- </doc>
- </method>
- <method name="setMaxReduceTaskFailuresPercent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="percent" type="int"/>
- <doc>
- <![CDATA[Set the maximum percentage of reduce tasks that can fail without the job
- being aborted.
-
- Each reduce task is executed a minimum of {@link #getMaxReduceAttempts()}
- attempts before being declared as <i>failed</i>.
-
- @param percent the maximum percentage of reduce tasks that can fail without
- the job being aborted.]]>
- </doc>
- </method>
- <method name="setJobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="prio" type="org.apache.hadoop.mapred.JobPriority"/>
- <doc>
- <![CDATA[Set {@link JobPriority} for this job.
-
- @param prio the {@link JobPriority} for this job.]]>
- </doc>
- </method>
- <method name="getJobPriority" return="org.apache.hadoop.mapred.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link JobPriority} for this job.
-
- @return the {@link JobPriority} for this job.]]>
- </doc>
- </method>
- <method name="getProfileEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether the task profiling is enabled.
- @return true if some tasks will be profiled]]>
- </doc>
- </method>
- <method name="setProfileEnabled"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newValue" type="boolean"/>
- <doc>
- <![CDATA[Set whether the system should collect profiler information for some of
- the tasks in this job? The information is stored in the user log
- directory.
- @param newValue true means it should be gathered]]>
- </doc>
- </method>
- <method name="getProfileParams" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the profiler configuration arguments.
- The default value for this property is
- "-agentlib:hprof=cpu=samples,heap=sites,force=n,thread=y,verbose=n,file=%s"
-
- @return the parameters to pass to the task child to configure profiling]]>
- </doc>
- </method>
- <method name="setProfileParams"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the profiler configuration arguments. If the string contains a '%s' it
- will be replaced with the name of the profiling output file when the task
- runs.
- This value is passed to the task child JVM on the command line.
- @param value the configuration string]]>
- </doc>
- </method>
- <method name="getProfileTaskRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="isMap" type="boolean"/>
- <doc>
- <![CDATA[Get the range of maps or reduces to profile.
- @param isMap is the task a map?
- @return the task ranges]]>
- </doc>
- </method>
- <method name="setProfileTaskRange"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="isMap" type="boolean"/>
- <param name="newValue" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the ranges of maps or reduces to profile. setProfileEnabled(true)
- must also be called.
- @param newValue a set of integer ranges of the map ids]]>
- </doc>
- </method>
- <method name="setMapDebugScript"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mDbgScript" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the debug script to run when the map tasks fail.
-
- <p>The debug script can aid debugging of failed map tasks. The script is
- given task's stdout, stderr, syslog, jobconf files as arguments.</p>
-
- <p>The debug command, run on the node where the map failed, is:</p>
- <p><pre><blockquote>
- $script $stdout $stderr $syslog $jobconf.
- </blockquote></pre></p>
-
- <p> The script file is distributed through {@link DistributedCache}
- APIs. The script needs to be symlinked. </p>
-
- <p>Here is an example on how to submit a script
- <p><blockquote><pre>
- job.setMapDebugScript("./myscript");
- DistributedCache.createSymlink(job);
- DistributedCache.addCacheFile("/debug/scripts/myscript#myscript");
- </pre></blockquote></p>
-
- @param mDbgScript the script name]]>
- </doc>
- </method>
- <method name="getMapDebugScript" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the map task's debug script.
-
- @return the debug Script for the mapred job for failed map tasks.
- @see #setMapDebugScript(String)]]>
- </doc>
- </method>
- <method name="setReduceDebugScript"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rDbgScript" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the debug script to run when the reduce tasks fail.
-
- <p>The debug script can aid debugging of failed reduce tasks. The script
- is given task's stdout, stderr, syslog, jobconf files as arguments.</p>
-
- <p>The debug command, run on the node where the map failed, is:</p>
- <p><pre><blockquote>
- $script $stdout $stderr $syslog $jobconf.
- </blockquote></pre></p>
-
- <p> The script file is distributed through {@link DistributedCache}
- APIs. The script file needs to be symlinked </p>
-
- <p>Here is an example on how to submit a script
- <p><blockquote><pre>
- job.setReduceDebugScript("./myscript");
- DistributedCache.createSymlink(job);
- DistributedCache.addCacheFile("/debug/scripts/myscript#myscript");
- </pre></blockquote></p>
-
- @param rDbgScript the script name]]>
- </doc>
- </method>
- <method name="getReduceDebugScript" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reduce task's debug Script
-
- @return the debug script for the mapred job for failed reduce tasks.
- @see #setReduceDebugScript(String)]]>
- </doc>
- </method>
- <method name="getJobEndNotificationURI" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the uri to be invoked in-order to send a notification after the job
- has completed (success/failure).
-
- @return the job end notification uri, <code>null</code> if it hasn't
- been set.
- @see #setJobEndNotificationURI(String)]]>
- </doc>
- </method>
- <method name="setJobEndNotificationURI"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uri" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the uri to be invoked in-order to send a notification after the job
- has completed (success/failure).
-
- <p>The uri can contain 2 special parameters: <tt>$jobId</tt> and
- <tt>$jobStatus</tt>. Those, if present, are replaced by the job's
- identifier and completion-status respectively.</p>
-
- <p>This is typically used by application-writers to implement chaining of
- Map-Reduce jobs in an <i>asynchronous manner</i>.</p>
-
- @param uri the job end notification uri
- @see JobStatus
- @see <a href="{@docRoot}/org/apache/hadoop/mapred/JobClient.html#
- JobCompletionAndChaining">Job Completion and Chaining</a>]]>
- </doc>
- </method>
- <method name="getJobLocalDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get job-specific shared directory for use as scratch space
-
- <p>
- When a job starts, a shared directory is created at location
- <code>
- ${mapred.local.dir}/taskTracker/$user/jobcache/$jobid/work/ </code>.
- This directory is exposed to the users through
- <code>job.local.dir </code>.
- So, the tasks can use this space
- as scratch space and share files among them. </p>
- This value is available as System property also.
-
- @return The localized job specific shared directory]]>
- </doc>
- </method>
- <method name="getMemoryForMapTask" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get memory required to run a map task of the job, in MB.
-
- If a value is specified in the configuration, it is returned.
- Else, it returns {@link #DISABLED_MEMORY_LIMIT}.
- <p/>
- For backward compatibility, if the job configuration sets the
- key {@link #MAPRED_TASK_MAXVMEM_PROPERTY} to a value different
- from {@link #DISABLED_MEMORY_LIMIT}, that value will be used
- after converting it from bytes to MB.
- @return memory required to run a map task of the job, in MB,
- or {@link #DISABLED_MEMORY_LIMIT} if unset.]]>
- </doc>
- </method>
- <method name="setMemoryForMapTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mem" type="long"/>
- </method>
- <method name="getMemoryForReduceTask" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get memory required to run a reduce task of the job, in MB.
-
- If a value is specified in the configuration, it is returned.
- Else, it returns {@link #DISABLED_MEMORY_LIMIT}.
- <p/>
- For backward compatibility, if the job configuration sets the
- key {@link #MAPRED_TASK_MAXVMEM_PROPERTY} to a value different
- from {@link #DISABLED_MEMORY_LIMIT}, that value will be used
- after converting it from bytes to MB.
- @return memory required to run a reduce task of the job, in MB,
- or {@link #DISABLED_MEMORY_LIMIT} if unset.]]>
- </doc>
- </method>
- <method name="setMemoryForReduceTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mem" type="long"/>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the name of the queue to which this job is submitted.
- Defaults to 'default'.
-
- @return name of the queue]]>
- </doc>
- </method>
- <method name="setQueueName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name of the queue to which this job should be submitted.
-
- @param queueName Name of the queue]]>
- </doc>
- </method>
- <method name="normalizeMemoryConfigValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="long"/>
- <doc>
- <![CDATA[Normalize the negative values in configuration
-
- @param val
- @return normalized value]]>
- </doc>
- </method>
- <method name="getMaxVirtualMemoryForTask" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getMemoryForMapTask()} and
- {@link #getMemoryForReduceTask()}">
- <doc>
- <![CDATA[Get the memory required to run a task of this job, in bytes. See
- {@link #MAPRED_TASK_MAXVMEM_PROPERTY}
- <p/>
- This method is deprecated. Now, different memory limits can be
- set for map and reduce tasks of a job, in MB.
- <p/>
- For backward compatibility, if the job configuration sets the
- key {@link #MAPRED_TASK_MAXVMEM_PROPERTY} to a value different
- from {@link #DISABLED_MEMORY_LIMIT}, that value is returned.
- Otherwise, this method will return the larger of the values returned by
- {@link #getMemoryForMapTask()} and {@link #getMemoryForReduceTask()}
- after converting them into bytes.
-
- @return Memory required to run a task of this job, in bytes,
- or {@link #DISABLED_MEMORY_LIMIT}, if unset.
- @see #setMaxVirtualMemoryForTask(long)
- @deprecated Use {@link #getMemoryForMapTask()} and
- {@link #getMemoryForReduceTask()}]]>
- </doc>
- </method>
- <method name="setMaxVirtualMemoryForTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #setMemoryForMapTask(long mem)} and
- Use {@link #setMemoryForReduceTask(long mem)}">
- <param name="vmem" type="long"/>
- <doc>
- <![CDATA[Set the maximum amount of memory any task of this job can use. See
- {@link #MAPRED_TASK_MAXVMEM_PROPERTY}
- <p/>
- mapred.task.maxvmem is split into
- mapred.job.map.memory.mb
- and mapred.job.map.memory.mb,mapred
- each of the new key are set
- as mapred.task.maxvmem / 1024
- as new values are in MB
- @param vmem Maximum amount of virtual memory in bytes any task of this job
- can use.
- @see #getMaxVirtualMemoryForTask()
- @deprecated
- Use {@link #setMemoryForMapTask(long mem)} and
- Use {@link #setMemoryForReduceTask(long mem)}]]>
- </doc>
- </method>
- <method name="getMaxPhysicalMemoryForTask" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="this variable is deprecated and nolonger in use.">
- <doc>
- <![CDATA[@deprecated this variable is deprecated and nolonger in use.]]>
- </doc>
- </method>
- <method name="setMaxPhysicalMemoryForTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mem" type="long"/>
- </method>
- <field name="MAPRED_TASK_MAXVMEM_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Use {@link #MAPRED_JOB_MAP_MEMORY_MB_PROPERTY} and
- {@link #MAPRED_JOB_REDUCE_MEMORY_MB_PROPERTY}">
- <doc>
- <![CDATA[@deprecated Use {@link #MAPRED_JOB_MAP_MEMORY_MB_PROPERTY} and
- {@link #MAPRED_JOB_REDUCE_MEMORY_MB_PROPERTY}]]>
- </doc>
- </field>
- <field name="UPPER_LIMIT_ON_TASK_VMEM_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="deprecated, no comment">
- <doc>
- <![CDATA[@deprecated]]>
- </doc>
- </field>
- <field name="MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="deprecated, no comment">
- <doc>
- <![CDATA[@deprecated]]>
- </doc>
- </field>
- <field name="MAPRED_TASK_MAXPMEM_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="deprecated, no comment">
- <doc>
- <![CDATA[@deprecated]]>
- </doc>
- </field>
- <field name="DISABLED_MEMORY_LIMIT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A value which if set for memory related configuration options,
- indicates that the options are turned off.]]>
- </doc>
- </field>
- <field name="MAPRED_LOCAL_DIR_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Property name for the configuration property mapred.local.dir]]>
- </doc>
- </field>
- <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Name of the queue to which jobs will be submitted, if no queue
- name is mentioned.]]>
- </doc>
- </field>
- <field name="MAPRED_JOB_MAP_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_JOB_REDUCE_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_TASK_JAVA_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Use {@link #MAPRED_MAP_TASK_JAVA_OPTS} or
- {@link #MAPRED_REDUCE_TASK_JAVA_OPTS}">
- <doc>
- <![CDATA[Configuration key to set the java command line options for the child
- map and reduce tasks.
-
- Java opts for the task tracker child processes.
- The following symbol, if present, will be interpolated: @taskid@.
- It is replaced by current TaskID. Any other occurrences of '@' will go
- unchanged.
- For example, to enable verbose gc logging to a file named for the taskid in
- /tmp and to set the heap maximum to be a gigabyte, pass a 'value' of:
- -Xmx1024m -verbose:gc -Xloggc:/tmp/@taskid@.gc
-
- The configuration variable {@link #MAPRED_TASK_ULIMIT} can be used to
- control the maximum virtual memory of the child processes.
-
- The configuration variable {@link #MAPRED_TASK_ENV} can be used to pass
- other environment variables to the child processes.
-
- @deprecated Use {@link #MAPRED_MAP_TASK_JAVA_OPTS} or
- {@link #MAPRED_REDUCE_TASK_JAVA_OPTS}]]>
- </doc>
- </field>
- <field name="MAPRED_MAP_TASK_JAVA_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the java command line options for the map tasks.
-
- Java opts for the task tracker child map processes.
- The following symbol, if present, will be interpolated: @taskid@.
- It is replaced by current TaskID. Any other occurrences of '@' will go
- unchanged.
- For example, to enable verbose gc logging to a file named for the taskid in
- /tmp and to set the heap maximum to be a gigabyte, pass a 'value' of:
- -Xmx1024m -verbose:gc -Xloggc:/tmp/@taskid@.gc
-
- The configuration variable {@link #MAPRED_MAP_TASK_ULIMIT} can be used to
- control the maximum virtual memory of the map processes.
-
- The configuration variable {@link #MAPRED_MAP_TASK_ENV} can be used to pass
- other environment variables to the map processes.]]>
- </doc>
- </field>
- <field name="MAPRED_REDUCE_TASK_JAVA_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the java command line options for the reduce tasks.
-
- Java opts for the task tracker child reduce processes.
- The following symbol, if present, will be interpolated: @taskid@.
- It is replaced by current TaskID. Any other occurrences of '@' will go
- unchanged.
- For example, to enable verbose gc logging to a file named for the taskid in
- /tmp and to set the heap maximum to be a gigabyte, pass a 'value' of:
- -Xmx1024m -verbose:gc -Xloggc:/tmp/@taskid@.gc
-
- The configuration variable {@link #MAPRED_REDUCE_TASK_ULIMIT} can be used
- to control the maximum virtual memory of the reduce processes.
-
- The configuration variable {@link #MAPRED_REDUCE_TASK_ENV} can be used to
- pass process environment variables to the reduce processes.]]>
- </doc>
- </field>
- <field name="DEFAULT_MAPRED_TASK_JAVA_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_TASK_ULIMIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Use {@link #MAPRED_MAP_TASK_ULIMIT} or
- {@link #MAPRED_REDUCE_TASK_ULIMIT}">
- <doc>
- <![CDATA[Configuration key to set the maximum virutal memory available to the child
- map and reduce tasks (in kilo-bytes).
-
- Note: This must be greater than or equal to the -Xmx passed to the JavaVM
- via {@link #MAPRED_TASK_JAVA_OPTS}, else the VM might not start.
-
- @deprecated Use {@link #MAPRED_MAP_TASK_ULIMIT} or
- {@link #MAPRED_REDUCE_TASK_ULIMIT}]]>
- </doc>
- </field>
- <field name="MAPRED_MAP_TASK_ULIMIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the maximum virutal memory available to the
- map tasks (in kilo-bytes).
-
- Note: This must be greater than or equal to the -Xmx passed to the JavaVM
- via {@link #MAPRED_MAP_TASK_JAVA_OPTS}, else the VM might not start.]]>
- </doc>
- </field>
- <field name="MAPRED_REDUCE_TASK_ULIMIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the maximum virutal memory available to the
- reduce tasks (in kilo-bytes).
-
- Note: This must be greater than or equal to the -Xmx passed to the JavaVM
- via {@link #MAPRED_REDUCE_TASK_JAVA_OPTS}, else the VM might not start.]]>
- </doc>
- </field>
- <field name="MAPRED_TASK_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Use {@link #MAPRED_MAP_TASK_ENV} or
- {@link #MAPRED_REDUCE_TASK_ENV}">
- <doc>
- <![CDATA[Configuration key to set the environment of the child map/reduce tasks.
-
- The format of the value is <code>k1=v1,k2=v2</code>. Further it can
- reference existing environment variables via <code>$key</code>.
-
- Example:
- <ul>
- <li> A=foo - This will set the env variable A to foo. </li>
- <li> B=$X:c This is inherit tasktracker's X env variable. </li>
- </ul>
-
- @deprecated Use {@link #MAPRED_MAP_TASK_ENV} or
- {@link #MAPRED_REDUCE_TASK_ENV}]]>
- </doc>
- </field>
- <field name="MAPRED_MAP_TASK_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the maximum virutal memory available to the
- map tasks.
-
- The format of the value is <code>k1=v1,k2=v2</code>. Further it can
- reference existing environment variables via <code>$key</code>.
-
- Example:
- <ul>
- <li> A=foo - This will set the env variable A to foo. </li>
- <li> B=$X:c This is inherit tasktracker's X env variable. </li>
- </ul>]]>
- </doc>
- </field>
- <field name="MAPRED_REDUCE_TASK_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set the maximum virutal memory available to the
- reduce tasks.
-
- The format of the value is <code>k1=v1,k2=v2</code>. Further it can
- reference existing environment variables via <code>$key</code>.
-
- Example:
- <ul>
- <li> A=foo - This will set the env variable A to foo. </li>
- <li> B=$X:c This is inherit tasktracker's X env variable. </li>
- </ul>]]>
- </doc>
- </field>
- <field name="WORKFLOW_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_NODE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_ADJACENCY_PREFIX_STRING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_ADJACENCY_PREFIX_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_TAGS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPREDUCE_RECOVER_JOB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_MAPREDUCE_RECOVER_JOB" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A map/reduce job configuration.
-
- <p><code>JobConf</code> is the primary interface for a user to describe a
- map-reduce job to the Hadoop framework for execution. The framework tries to
- faithfully execute the job as-is described by <code>JobConf</code>, however:
- <ol>
- <li>
- Some configuration parameters might have been marked as
- <a href="{@docRoot}/org/apache/hadoop/conf/Configuration.html#FinalParams">
- final</a> by administrators and hence cannot be altered.
- </li>
- <li>
- While some job parameters are straight-forward to set
- (e.g. {@link #setNumReduceTasks(int)}), some parameters interact subtly
- rest of the framework and/or job-configuration and is relatively more
- complex for the user to control finely (e.g. {@link #setNumMapTasks(int)}).
- </li>
- </ol></p>
-
- <p><code>JobConf</code> typically specifies the {@link Mapper}, combiner
- (if any), {@link Partitioner}, {@link Reducer}, {@link InputFormat} and
- {@link OutputFormat} implementations to be used etc.
- <p>Optionally <code>JobConf</code> is used to specify other advanced facets
- of the job such as <code>Comparator</code>s to be used, files to be put in
- the {@link DistributedCache}, whether or not intermediate and/or job outputs
- are to be compressed (and how), debugability via user-provided scripts
- ( {@link #setMapDebugScript(String)}/{@link #setReduceDebugScript(String)}),
- for doing post-processing on task logs, task's stdout, stderr, syslog.
- and etc.</p>
-
- <p>Here is an example on how to configure a job via <code>JobConf</code>:</p>
- <p><blockquote><pre>
- // Create a new JobConf
- JobConf job = new JobConf(new Configuration(), MyJob.class);
-
- // Specify various job-specific parameters
- job.setJobName("myjob");
-
- FileInputFormat.setInputPaths(job, new Path("in"));
- FileOutputFormat.setOutputPath(job, new Path("out"));
-
- job.setMapperClass(MyJob.MyMapper.class);
- job.setCombinerClass(MyJob.MyReducer.class);
- job.setReducerClass(MyJob.MyReducer.class);
-
- job.setInputFormat(SequenceFileInputFormat.class);
- job.setOutputFormat(SequenceFileOutputFormat.class);
- </pre></blockquote></p>
-
- @see JobClient
- @see ClusterStatus
- @see Tool
- @see DistributedCache]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobConf -->
- <!-- start interface org.apache.hadoop.mapred.JobConfigurable -->
- <interface name="JobConfigurable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Initializes a new instance from a {@link JobConf}.
- @param job the configuration]]>
- </doc>
- </method>
- <doc>
- <![CDATA[That what may be configured.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.JobConfigurable -->
- <!-- start class org.apache.hadoop.mapred.JobContext -->
- <class name="JobContext" extends="org.apache.hadoop.mapreduce.JobContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job Configuration
-
- @return JobConf]]>
- </doc>
- </method>
- <method name="getProgressible" return="org.apache.hadoop.util.Progressable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the progress mechanism for reporting progress.
-
- @return progress mechanism]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobContext -->
- <!-- start class org.apache.hadoop.mapred.JobEndNotifier -->
- <class name="JobEndNotifier" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobEndNotifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="startNotifier"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="stopNotifier"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="registerNotification"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="status" type="org.apache.hadoop.mapred.JobStatus"/>
- </method>
- <method name="localRunnerNotification"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="status" type="org.apache.hadoop.mapred.JobStatus"/>
- </method>
- <field name="MAPREDUCE_JOBEND_NOTIFICATION_TIMEOUT_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobEndNotifier -->
- <!-- start class org.apache.hadoop.mapred.JobHistory -->
- <class name="JobHistory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getHistoryFilePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <doc>
- <![CDATA[Given the job id, return the history file path from the cache]]>
- </doc>
- </method>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobTracker" type="org.apache.hadoop.mapred.JobTracker"/>
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="hostname" type="java.lang.String"/>
- <param name="jobTrackerStartTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize JobHistory files.
- @param conf Jobconf of the job tracker.
- @param hostname jobtracker's hostname
- @param jobTrackerStartTime jobtracker's start time]]>
- </doc>
- </method>
- <method name="parseHistoryFromFS"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <param name="l" type="org.apache.hadoop.mapred.JobHistory.Listener"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parses history file and invokes Listener.handle() for
- each line of history. It can be used for looking through history
- files for specific items without having to keep whole history in memory.
- @param path path to history file
- @param l Listener for history events
- @param fs FileSystem where history file is present
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskLogsUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attempt" type="org.apache.hadoop.mapred.JobHistory.TaskAttempt"/>
- <doc>
- <![CDATA[Return the TaskLogsUrl of a particular TaskAttempt
-
- @param attempt
- @return the taskLogsUrl. null if http-port or tracker-name or
- task-attempt-id are unavailable.]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_NAME_TRIM_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DONEDIR_FS" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="DONE" type="org.apache.hadoop.fs.Path"
- transient="false" volatile="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="JOBHISTORY_FILENAME_REGEX" type="java.util.regex.Pattern"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_FILENAME_REGEX" type="java.util.regex.Pattern"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Provides methods for writing to and reading from job history.
- Job History works in an append mode, JobHistory and its inner classes provide methods
- to log job events.
-
- JobHistory is split into multiple files, format of each file is plain text where each line
- is of the format [type (key=value)*], where type identifies the type of the record.
- Type maps to UID of one of the inner classes of this class.
-
- Job history is maintained in a master index which contains star/stop times of all jobs with
- a few other job level properties. Apart from this each job's history is maintained in a seperate history
- file. name of job history files follows the format jobtrackerId_jobid
-
- For parsing the job history it supports a listener based interface where each line is parsed
- and passed to listener. The listener can create an object model of history or look for specific
- events and discard rest of the history.
-
- CHANGE LOG :
- Version 0 : The history has the following format :
- TAG KEY1="VALUE1" KEY2="VALUE2" and so on.
- TAG can be Job, Task, MapAttempt or ReduceAttempt.
- Note that a '"' is the line delimiter.
- Version 1 : Changes the line delimiter to '.'
- Values are now escaped for unambiguous parsing.
- Added the Meta tag to store version info.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.HistoryCleaner -->
- <class name="JobHistory.HistoryCleaner" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Runnable"/>
- <constructor name="JobHistory.HistoryCleaner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Cleans up history data.]]>
- </doc>
- </method>
- <method name="clean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="now" type="long"/>
- </method>
- <doc>
- <![CDATA[Delete history files older than one month. Update master index and remove all
- jobs older than one month. Also if a job tracker has no jobs in last one month
- remove reference to the job tracker.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.HistoryCleaner -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.JobInfo -->
- <class name="JobHistory.JobInfo" extends="org.apache.hadoop.mapred.JobHistory.KeyValuePair"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory.JobInfo" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create new JobInfo]]>
- </doc>
- </constructor>
- <method name="getAllTasks" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns all map and reduce tasks <taskid-Task>.]]>
- </doc>
- </method>
- <method name="getJobACLs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job acls.
-
- @return a {@link Map} from {@link JobACL} to {@link AccessControlList}]]>
- </doc>
- </method>
- <method name="handle"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="values" type="java.util.Map"/>
- </method>
- <method name="getLocalJobFilePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <doc>
- <![CDATA[Get the path of the locally stored job file
- @param jobId id of the job
- @return the path of the job file on the local file system]]>
- </doc>
- </method>
- <method name="encodeJobHistoryFilePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logFile" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Helper function to encode the URL of the path of the job-history
- log file.
-
- @param logFile path of the job-history file
- @return URL encoded path
- @throws IOException]]>
- </doc>
- </method>
- <method name="encodeJobHistoryFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logFileName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Helper function to encode the URL of the filename of the job-history
- log file.
-
- @param logFileName file name of the job-history file
- @return URL encoded filename
- @throws IOException]]>
- </doc>
- </method>
- <method name="decodeJobHistoryFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logFileName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Helper function to decode the URL of the filename of the job-history
- log file.
-
- @param logFileName file name of the job-history file
- @return URL decoded filename
- @throws IOException]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the user name from the job conf]]>
- </doc>
- </method>
- <method name="getWorkflowAdjacencies" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the workflow adjacencies from the job conf
- The string returned is of the form "key"="value" "key"="value" ...]]>
- </doc>
- </method>
- <method name="getJobHistoryLogLocation" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logFileName" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the job history file path given the history filename]]>
- </doc>
- </method>
- <method name="getJobHistoryLogLocationForUser" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logFileName" type="java.lang.String"/>
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the user job history file path]]>
- </doc>
- </method>
- <method name="getJobHistoryFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Recover the job history filename from the history folder.
- Uses the following pattern
- $jt-hostname_[0-9]*_$job-id_$user_$job-name*
- @param jobConf the job conf
- @param id job id]]>
- </doc>
- </method>
- <method name="recoverJobHistoryFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="logFilePath" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Selects one of the two files generated as a part of recovery.
- The thumb rule is that always select the oldest file.
- This call makes sure that only one file is left in the end.
- @param conf job conf
- @param logFilePath Path of the log file
- @throws IOException]]>
- </doc>
- </method>
- <method name="logSubmitted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logSubmitted(JobID, JobConf, String, long, boolean)} instead.">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="jobConfPath" type="java.lang.String"/>
- <param name="submitTime" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Log job submitted event to history. Creates a new file in history
- for the job. if history file creation fails, it disables history
- for all other events.
- @param jobId job id assigned by job tracker.
- @param jobConf job conf of the job
- @param jobConfPath path to job conf xml file in HDFS.
- @param submitTime time when job tracker received the job
- @throws IOException
- @deprecated Use
- {@link #logSubmitted(JobID, JobConf, String, long, boolean)} instead.]]>
- </doc>
- </method>
- <method name="logSubmitted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="jobConfPath" type="java.lang.String"/>
- <param name="submitTime" type="long"/>
- <param name="restarted" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="logInited"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="startTime" type="long"/>
- <param name="totalMaps" type="int"/>
- <param name="totalReduces" type="int"/>
- <doc>
- <![CDATA[Logs launch time of job.
-
- @param jobId job id, assigned by jobtracker.
- @param startTime start time of job.
- @param totalMaps total maps assigned by jobtracker.
- @param totalReduces total reduces.]]>
- </doc>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #logInited(JobID, long, int, int)} and
- {@link #logStarted(JobID)}">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="startTime" type="long"/>
- <param name="totalMaps" type="int"/>
- <param name="totalReduces" type="int"/>
- <doc>
- <![CDATA[Logs the job as RUNNING.
- @param jobId job id, assigned by jobtracker.
- @param startTime start time of job.
- @param totalMaps total maps assigned by jobtracker.
- @param totalReduces total reduces.
- @deprecated Use {@link #logInited(JobID, long, int, int)} and
- {@link #logStarted(JobID)}]]>
- </doc>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <doc>
- <![CDATA[Logs job as running
- @param jobId job id, assigned by jobtracker.]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="finishTime" type="long"/>
- <param name="finishedMaps" type="int"/>
- <param name="finishedReduces" type="int"/>
- <param name="failedMaps" type="int"/>
- <param name="failedReduces" type="int"/>
- <param name="mapCounters" type="org.apache.hadoop.mapred.Counters"/>
- <param name="reduceCounters" type="org.apache.hadoop.mapred.Counters"/>
- <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Log job finished. closes the job file in history.
- @param jobId job id, assigned by jobtracker.
- @param finishTime finish time of job in ms.
- @param finishedMaps no of maps successfully finished.
- @param finishedReduces no of reduces finished sucessfully.
- @param failedMaps no of failed map tasks.
- @param failedReduces no of failed reduce tasks.
- @param counters the counters from the job]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="timestamp" type="long"/>
- <param name="finishedMaps" type="int"/>
- <param name="finishedReduces" type="int"/>
- <param name="failReason" type="java.lang.String"/>
- <doc>
- <![CDATA[Logs job failed event. Closes the job history log file.
- @param jobid job id
- @param timestamp time when job failure was detected in ms.
- @param finishedMaps no finished map tasks.
- @param finishedReduces no of finished reduce tasks.]]>
- </doc>
- </method>
- <method name="logKilled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="timestamp" type="long"/>
- <param name="finishedMaps" type="int"/>
- <param name="finishedReduces" type="int"/>
- <doc>
- <![CDATA[Logs job killed event. Closes the job history log file.
-
- @param jobid
- job id
- @param timestamp
- time when job killed was issued in ms.
- @param finishedMaps
- no finished map tasks.
- @param finishedReduces
- no of finished reduce tasks.]]>
- </doc>
- </method>
- <method name="logJobPriority"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="priority" type="org.apache.hadoop.mapred.JobPriority"/>
- <doc>
- <![CDATA[Log job's priority.
- @param jobid job id
- @param priority Jobs priority]]>
- </doc>
- </method>
- <method name="logJobInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link #logJobInfo(JobID, long, long)} instead.">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="submitTime" type="long"/>
- <param name="launchTime" type="long"/>
- <param name="restartCount" type="int"/>
- <doc>
- <![CDATA[Log job's submit-time/launch-time
- @param jobid job id
- @param submitTime job's submit time
- @param launchTime job's launch time
- @param restartCount number of times the job got restarted
- @deprecated Use {@link #logJobInfo(JobID, long, long)} instead.]]>
- </doc>
- </method>
- <method name="logJobInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="submitTime" type="long"/>
- <param name="launchTime" type="long"/>
- </method>
- <doc>
- <![CDATA[Helper class for logging or reading back events related to job start, finish or failure.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.JobInfo -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.Keys -->
- <class name="JobHistory.Keys" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobHistory.Keys[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.Keys"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="JOBTRACKERID" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="START_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FINISH_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOBID" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOBNAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USER" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOBCONF" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUBMIT_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LAUNCH_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOTAL_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOTAL_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FINISHED_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FINISHED_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_STATUS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASKID" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HOSTNAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_TYPE" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ERROR" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_ATTEMPT_ID" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_STATUS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COPY_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SORT_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHUFFLE_FINISHED" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SORT_FINISHED" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COUNTERS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SPLITS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_PRIORITY" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HTTP_PORT" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TRACKER_NAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STATE_STRING" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VERSION" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_COUNTERS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_COUNTERS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VIEW_JOB" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MODIFY_JOB" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_QUEUE" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAIL_REASON" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOCALITY" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AVATAAR" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_ID" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_NAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_NODE_NAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_ADJACENCIES" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WORKFLOW_TAGS" type="org.apache.hadoop.mapred.JobHistory.Keys"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Job history files contain key="value" pairs, where keys belong to this enum.
- It acts as a global namespace for all keys.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.Keys -->
- <!-- start interface org.apache.hadoop.mapred.JobHistory.Listener -->
- <interface name="JobHistory.Listener" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="handle"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recType" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"/>
- <param name="values" type="java.util.Map"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Callback method for history parser.
- @param recType type of record, which is the first entry in the line.
- @param values a map of key-value pairs as thry appear in history.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Callback interface for reading back log events from JobHistory. This interface
- should be implemented and passed to JobHistory.parseHistory()]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.JobHistory.Listener -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.MapAttempt -->
- <class name="JobHistory.MapAttempt" extends="org.apache.hadoop.mapred.JobHistory.TaskAttempt"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory.MapAttempt"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logStarted(TaskAttemptID, long, String, int, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Log start time of this map task attempt.
- @param taskAttemptId task attempt id
- @param startTime start time of task attempt as reported by task tracker.
- @param hostName host name of the task attempt.
- @deprecated Use
- {@link #logStarted(TaskAttemptID, long, String, int, String)}]]>
- </doc>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="trackerName" type="java.lang.String"/>
- <param name="httpPort" type="int"/>
- <param name="taskType" type="java.lang.String"/>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="trackerName" type="java.lang.String"/>
- <param name="httpPort" type="int"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="locality" type="org.apache.hadoop.mapred.Locality"/>
- <param name="avataar" type="org.apache.hadoop.mapred.Avataar"/>
- <doc>
- <![CDATA[Log start time of this map task attempt.
-
- @param taskAttemptId task attempt id
- @param startTime start time of task attempt as reported by task tracker.
- @param trackerName name of the tracker executing the task attempt.
- @param httpPort http port of the task tracker executing the task attempt
- @param taskType Whether the attempt is cleanup or setup or map
- @param locality the data locality of the task attempt
- @param Avataar the avataar of the task attempt]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logFinished(TaskAttemptID, long, String, String, String, Counters)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="finishTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Log finish time of map task attempt.
- @param taskAttemptId task attempt id
- @param finishTime finish time
- @param hostName host name
- @deprecated Use
- {@link #logFinished(TaskAttemptID, long, String, String, String, Counters)}]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="finishTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="stateString" type="java.lang.String"/>
- <param name="counter" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Log finish time of map task attempt.
-
- @param taskAttemptId task attempt id
- @param finishTime finish time
- @param hostName host name
- @param taskType Whether the attempt is cleanup or setup or map
- @param stateString state string of the task attempt
- @param counter counters of the task attempt]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logFailed(TaskAttemptID, long, String, String, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <doc>
- <![CDATA[Log task attempt failed event.
- @param taskAttemptId task attempt id
- @param timestamp timestamp
- @param hostName hostname of this task attempt.
- @param error error message if any for this task attempt.
- @deprecated Use
- {@link #logFailed(TaskAttemptID, long, String, String, String)}]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <doc>
- <![CDATA[Log task attempt failed event.
-
- @param taskAttemptId task attempt id
- @param timestamp timestamp
- @param hostName hostname of this task attempt.
- @param error error message if any for this task attempt.
- @param taskType Whether the attempt is cleanup or setup or map]]>
- </doc>
- </method>
- <method name="logKilled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logKilled(TaskAttemptID, long, String, String, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <doc>
- <![CDATA[Log task attempt killed event.
- @param taskAttemptId task attempt id
- @param timestamp timestamp
- @param hostName hostname of this task attempt.
- @param error error message if any for this task attempt.
- @deprecated Use
- {@link #logKilled(TaskAttemptID, long, String, String, String)}]]>
- </doc>
- </method>
- <method name="logKilled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <doc>
- <![CDATA[Log task attempt killed event.
-
- @param taskAttemptId task attempt id
- @param timestamp timestamp
- @param hostName hostname of this task attempt.
- @param error error message if any for this task attempt.
- @param taskType Whether the attempt is cleanup or setup or map]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helper class for logging or reading back events related to start, finish or failure of
- a Map Attempt on a node.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.MapAttempt -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.RecordTypes -->
- <class name="JobHistory.RecordTypes" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobHistory.RecordTypes[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="Jobtracker" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="Job" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="Task" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MapAttempt" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ReduceAttempt" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="Meta" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Record types are identifiers for each line of log in history files.
- A record type appears as the first token in a single line of log.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.RecordTypes -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.ReduceAttempt -->
- <class name="JobHistory.ReduceAttempt" extends="org.apache.hadoop.mapred.JobHistory.TaskAttempt"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory.ReduceAttempt"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logStarted(TaskAttemptID, long, String, int, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Log start time of Reduce task attempt.
- @param taskAttemptId task attempt id
- @param startTime start time
- @param hostName host name
- @deprecated Use
- {@link #logStarted(TaskAttemptID, long, String, int, String)}]]>
- </doc>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="trackerName" type="java.lang.String"/>
- <param name="httpPort" type="int"/>
- <param name="taskType" type="java.lang.String"/>
- </method>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="startTime" type="long"/>
- <param name="trackerName" type="java.lang.String"/>
- <param name="httpPort" type="int"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="locality" type="org.apache.hadoop.mapred.Locality"/>
- <param name="avataar" type="org.apache.hadoop.mapred.Avataar"/>
- <doc>
- <![CDATA[Log start time of Reduce task attempt.
-
- @param taskAttemptId task attempt id
- @param startTime start time
- @param trackerName tracker name
- @param httpPort the http port of the tracker executing the task attempt
- @param taskType Whether the attempt is cleanup or setup or reduce
- @param locality the data locality of the task attempt
- @param Avataar the avataar of the task attempt]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logFinished(TaskAttemptID, long, long, long, String, String, String, Counters)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="shuffleFinished" type="long"/>
- <param name="sortFinished" type="long"/>
- <param name="finishTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Log finished event of this task.
- @param taskAttemptId task attempt id
- @param shuffleFinished shuffle finish time
- @param sortFinished sort finish time
- @param finishTime finish time of task
- @param hostName host name where task attempt executed
- @deprecated Use
- {@link #logFinished(TaskAttemptID, long, long, long, String, String, String, Counters)}]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="shuffleFinished" type="long"/>
- <param name="sortFinished" type="long"/>
- <param name="finishTime" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="stateString" type="java.lang.String"/>
- <param name="counter" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Log finished event of this task.
-
- @param taskAttemptId task attempt id
- @param shuffleFinished shuffle finish time
- @param sortFinished sort finish time
- @param finishTime finish time of task
- @param hostName host name where task attempt executed
- @param taskType Whether the attempt is cleanup or setup or reduce
- @param stateString the state string of the attempt
- @param counter counters of the attempt]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logFailed(TaskAttemptID, long, String, String, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <doc>
- <![CDATA[Log failed reduce task attempt.
- @param taskAttemptId task attempt id
- @param timestamp time stamp when task failed
- @param hostName host name of the task attempt.
- @param error error message of the task.
- @deprecated Use
- {@link #logFailed(TaskAttemptID, long, String, String, String)}]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <doc>
- <![CDATA[Log failed reduce task attempt.
-
- @param taskAttemptId task attempt id
- @param timestamp time stamp when task failed
- @param hostName host name of the task attempt.
- @param error error message of the task.
- @param taskType Whether the attempt is cleanup or setup or reduce]]>
- </doc>
- </method>
- <method name="logKilled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use
- {@link #logKilled(TaskAttemptID, long, String, String, String)}">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <doc>
- <![CDATA[Log killed reduce task attempt.
- @param taskAttemptId task attempt id
- @param timestamp time stamp when task failed
- @param hostName host name of the task attempt.
- @param error error message of the task.
- @deprecated Use
- {@link #logKilled(TaskAttemptID, long, String, String, String)}]]>
- </doc>
- </method>
- <method name="logKilled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="timestamp" type="long"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="error" type="java.lang.String"/>
- <param name="taskType" type="java.lang.String"/>
- <doc>
- <![CDATA[Log killed reduce task attempt.
-
- @param taskAttemptId task attempt id
- @param timestamp time stamp when task failed
- @param hostName host name of the task attempt.
- @param error error message of the task.
- @param taskType Whether the attempt is cleanup or setup or reduce]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helper class for logging or reading back events related to start, finish or failure of
- a Map Attempt on a node.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.ReduceAttempt -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.Task -->
- <class name="JobHistory.Task" extends="org.apache.hadoop.mapred.JobHistory.KeyValuePair"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory.Task"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="logStarted"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="startTime" type="long"/>
- <param name="splitLocations" type="java.lang.String"/>
- <doc>
- <![CDATA[Log start time of task (TIP).
- @param taskId task id
- @param taskType MAP or REDUCE
- @param startTime startTime of tip.]]>
- </doc>
- </method>
- <method name="logFinished"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="finishTime" type="long"/>
- <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Log finish time of task.
- @param taskId task id
- @param taskType MAP or REDUCE
- @param finishTime finish timeof task in ms]]>
- </doc>
- </method>
- <method name="logUpdates"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
- <param name="finishTime" type="long"/>
- <doc>
- <![CDATA[Update the finish time of task.
- @param taskId task id
- @param finishTime finish time of task in ms]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="time" type="long"/>
- <param name="error" type="java.lang.String"/>
- <doc>
- <![CDATA[Log job failed event.
- @param taskId task id
- @param taskType MAP or REDUCE.
- @param time timestamp when job failed detected.
- @param error error message for failure.]]>
- </doc>
- </method>
- <method name="logFailed"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
- <param name="taskType" type="java.lang.String"/>
- <param name="time" type="long"/>
- <param name="error" type="java.lang.String"/>
- <param name="failedDueToAttempt" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <doc>
- <![CDATA[@param failedDueToAttempt The attempt that caused the failure, if any]]>
- </doc>
- </method>
- <method name="getTaskAttempts" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns all task attempts for this task. <task attempt id - TaskAttempt>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Helper class for logging or reading back events related to Task's start, finish or failure.
- All events logged by this class are logged in a separate file per job in
- job tracker history. These events map to TIPs in jobtracker.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.Task -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.TaskAttempt -->
- <class name="JobHistory.TaskAttempt" extends="org.apache.hadoop.mapred.JobHistory.Task"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistory.TaskAttempt"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Base class for Map and Reduce TaskAttempts.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.TaskAttempt -->
- <!-- start class org.apache.hadoop.mapred.JobHistory.Values -->
- <class name="JobHistory.Values" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobHistory.Values[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.Values"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SUCCESS" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PREP" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP" type="org.apache.hadoop.mapred.JobHistory.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This enum contains some of the values commonly used by history log events.
- since values in history can only be strings - Values.name() is used in
- most places in history file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistory.Values -->
- <!-- start class org.apache.hadoop.mapred.JobHistoryServer -->
- <class name="JobHistoryServer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistoryServer" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts job history server as a independent process
- * Initializes ACL Manager
- * Starts a webapp to service history requests
- @param conf - Mr Cluster configuration
- @throws IOException - any exception starting history server]]>
- </doc>
- </constructor>
- <constructor name="JobHistoryServer" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.mapred.ACLsManager, org.apache.hadoop.http.HttpServer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Starts job history server as a embedded server within job tracker
- * Starts a webapp to service history requests
- @param conf - MR Cluster configuration
- @param aclsManager - ACLs Manager for user authentication
- @param httpServer - Http Server instance
- @throws IOException - any exception starting history server]]>
- </doc>
- </constructor>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="join"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Shutsdown the history server if already initialized
- @throws Exception - Any exception during shutdown]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Start job history server as an independent process
- @param args - Command line arguments]]>
- </doc>
- </method>
- <field name="MAPRED_HISTORY_SERVER_HTTP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_HISTORY_SERVER_EMBEDDED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[{@link JobHistoryServer} is responsible for servicing all job history
- related requests from client.
- History Server can be initialized in one of two modes
- * Emdedded within {@link JobTracker}
- * External daemon, can either be run on the job tracker node or outside
- Two {@link Configuration} entries in mapred-site.xml govern the functioning
- of the history server
- mapred.job.history.server.http.address is address to which history web
- server is bound to. If operating in embedded mode, the hostname on
- history address has to be same as the job tracker host name
- mapred.job.history.server.embedded (default is true) will cause job tracker
- to init history server, else the server need to be started as a
- separate daemon process]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobHistoryServer -->
- <!-- start class org.apache.hadoop.mapred.JobID -->
- <class name="JobID" extends="org.apache.hadoop.mapreduce.JobID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobID" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a JobID object
- @param jtIdentifier jobTracker identifier
- @param id job number]]>
- </doc>
- </constructor>
- <constructor name="JobID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="downgrade" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="old" type="org.apache.hadoop.mapreduce.JobID"/>
- <doc>
- <![CDATA[Downgrade a new JobID to an old one
- @param old a new or old JobID
- @return either old or a new JobID build to match old]]>
- </doc>
- </method>
- <method name="read" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="forName" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a JobId object from given string
- @return constructed JobId object or null if the given String is null
- @throws IllegalArgumentException if the given string is malformed]]>
- </doc>
- </method>
- <method name="getJobIDsPattern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jtIdentifier" type="java.lang.String"/>
- <param name="jobId" type="java.lang.Integer"/>
- <doc>
- <![CDATA[Returns a regex pattern which matches task IDs. Arguments can
- be given null, in which case that part of the regex will be generic.
- For example to obtain a regex matching <i>any job</i>
- run on the jobtracker started at <i>200707121733</i>, we would use :
- <pre>
- JobID.getTaskIDsPattern("200707121733", null);
- </pre>
- which will return :
- <pre> "job_200707121733_[0-9]*" </pre>
- @param jtIdentifier jobTracker identifier, or null
- @param jobId job number, or null
- @return a regex pattern matching JobIDs]]>
- </doc>
- </method>
- <doc>
- <![CDATA[JobID represents the immutable and unique identifier for
- the job. JobID consists of two parts. First part
- represents the jobtracker identifier, so that jobID to jobtracker map
- is defined. For cluster setup this string is the jobtracker
- start time, for local setting, it is "local".
- Second part of the JobID is the job number. <br>
- An example JobID is :
- <code>job_200707121733_0003</code> , which represents the third job
- running at the jobtracker started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse JobID strings, but rather
- use appropriate constructors or {@link #forName(String)} method.
-
- @see TaskID
- @see TaskAttemptID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobID -->
- <!-- start class org.apache.hadoop.mapred.JobInProgress -->
- <class name="JobInProgress" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobInProgress" type="org.apache.hadoop.mapred.JobID, org.apache.hadoop.mapred.JobConf, org.apache.hadoop.mapred.JobTracker"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an almost empty JobInProgress, which can be used only for tests]]>
- </doc>
- </constructor>
- <method name="getQueueMetrics" return="org.apache.hadoop.mapred.QueueMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the QueueMetrics object associated with this job
- @return QueueMetrics]]>
- </doc>
- </method>
- <method name="cleanUpMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Called when the job is complete]]>
- </doc>
- </method>
- <method name="inited" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check if the job has been initialized.
- @return <code>true</code> if the job has been initialized,
- <code>false</code> otherwise]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user for the job]]>
- </doc>
- </method>
- <method name="initTasks"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="JobInProgress.KillInterruptedException" type="org.apache.hadoop.mapred.JobInProgress.KillInterruptedException"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- <doc>
- <![CDATA[Construct the splits, etc. This is invoked from an async
- thread so that split-computation doesn't block anyone.]]>
- </doc>
- </method>
- <method name="getProfile" return="org.apache.hadoop.mapred.JobProfile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStatus" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLaunchTime" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="desiredMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finishedMaps" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="desiredReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="runningMaps" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="runningReduces" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="finishedReduces" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="pendingMaps" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="pendingReduces" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="desiredTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return total number of map and reduce tasks desired by the job.
- @return total number of map and reduce tasks desired by the job]]>
- </doc>
- </method>
- <method name="getNumSlotsPerTask" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- </method>
- <method name="getPriority" return="org.apache.hadoop.mapred.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.mapred.JobPriority"/>
- </method>
- <method name="reportTasksInProgress" return="java.util.Vector"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shouldBeMap" type="boolean"/>
- <param name="shouldBeComplete" type="boolean"/>
- <doc>
- <![CDATA[Return a vector of completed TaskInProgress objects]]>
- </doc>
- </method>
- <method name="reportCleanupTIPs" return="java.util.Vector"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shouldBeComplete" type="boolean"/>
- <doc>
- <![CDATA[Return a vector of cleanup TaskInProgress objects]]>
- </doc>
- </method>
- <method name="reportSetupTIPs" return="java.util.Vector"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shouldBeComplete" type="boolean"/>
- <doc>
- <![CDATA[Return a vector of setup TaskInProgress objects]]>
- </doc>
- </method>
- <method name="updateTaskStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskInProgress"/>
- <param name="status" type="org.apache.hadoop.mapred.TaskStatus"/>
- <doc>
- <![CDATA[Assuming {@link JobTracker} is locked on entry.]]>
- </doc>
- </method>
- <method name="getJobCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the job-level counters.
-
- @return the job-level counters.]]>
- </doc>
- </method>
- <method name="getMapCounters" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Returns map phase counters by summing over all map tasks in progress.
- This method returns true if counters are within limit or false.]]>
- </doc>
- </method>
- <method name="getReduceCounters" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Returns map phase counters by summing over all map tasks in progress.
- This method returns true if counters are within limits and false otherwise.]]>
- </doc>
- </method>
- <method name="getCounters" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="result" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Returns the total job counters, by adding together the job,
- the map and the reduce counters. This method returns true if
- counters are within limits and false otherwise.]]>
- </doc>
- </method>
- <method name="obtainNewMapTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a MapTask, if appropriate, to run on the given tasktracker]]>
- </doc>
- </method>
- <method name="obtainNewMapTaskCommon" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <param name="maxCacheLevel" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a MapTask with locality level that smaller or equal than a given
- locality level to tasktracker.
-
- @param tts The task tracker that is asking for a task
- @param clusterSize The number of task trackers in the cluster
- @param numUniqueHosts The number of hosts that run task trackers
- @param avgProgress The average progress of this kind of task in this job
- @param maxCacheLevel The maximum topology level until which to schedule
- maps.
- @return the index in tasks of the selected task (or -1 for no task)
- @throws IOException]]>
- </doc>
- </method>
- <method name="obtainTaskCleanupTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="isMapSlot" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="obtainNewNodeLocalMapTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="obtainNewNodeOrRackLocalMapTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="obtainNewNonLocalMapTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="schedulingOpportunity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="resetSchedulingOpportunities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumSchedulingOpportunities" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="overrideSchedulingOpportunities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="scheduleOffSwitch" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numTaskTrackers" type="int"/>
- <doc>
- <![CDATA[Check if we can schedule an off-switch task for this job.
-
- @param numTaskTrackers number of tasktrackers
- @return <code>true</code> if we can schedule off-switch,
- <code>false</code> otherwise
- We check the number of missed opportunities for the job.
- If it has 'waited' long enough we go ahead and schedule.]]>
- </doc>
- </method>
- <method name="obtainJobCleanupTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <param name="isMapSlot" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a CleanupTask, if appropriate, to run on the given tasktracker]]>
- </doc>
- </method>
- <method name="obtainJobSetupTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <param name="isMapSlot" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a SetupTask, if appropriate, to run on the given tasktracker]]>
- </doc>
- </method>
- <method name="scheduleReduces" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="obtainNewReduceTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tts" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="clusterSize" type="int"/>
- <param name="numUniqueHosts" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return a ReduceTask, if appropriate, to run on the given tasktracker.
- We don't have cache-sensitivity for reduce tasks, as they
- work on temporary MapRed files.]]>
- </doc>
- </method>
- <method name="reserveTaskTracker"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskTracker" type="org.apache.hadoop.mapreduce.server.jobtracker.TaskTracker"/>
- <param name="type" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="numSlots" type="int"/>
- </method>
- <method name="unreserveTaskTracker"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskTracker" type="org.apache.hadoop.mapreduce.server.jobtracker.TaskTracker"/>
- <param name="type" type="org.apache.hadoop.mapreduce.TaskType"/>
- </method>
- <method name="getNumReservedTaskTrackersForMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumReservedTaskTrackersForReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="scheduleMap"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskInProgress"/>
- <doc>
- <![CDATA[Adds a map tip to the list of running maps.
- @param tip the tip that needs to be scheduled as running]]>
- </doc>
- </method>
- <method name="scheduleReduce"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskInProgress"/>
- <doc>
- <![CDATA[Adds a reduce tip to the list of running reduces
- @param tip the tip that needs to be scheduled as running]]>
- </doc>
- </method>
- <method name="findSpeculativeTask" return="org.apache.hadoop.mapred.TaskInProgress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="list" type="java.util.Collection"/>
- <param name="ttStatus" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="avgProgress" type="double"/>
- <param name="currentTime" type="long"/>
- <param name="shouldRemove" type="boolean"/>
- <doc>
- <![CDATA[Find a speculative task
- @param list a list of tips
- @param ttStatus status of the tracker that has requested a tip
- @param avgProgress the average progress for speculation
- @param currentTime current time in milliseconds
- @param shouldRemove whether to remove the tips
- @return a tip that can be speculated on the tracker]]>
- </doc>
- </method>
- <method name="completedTask" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskInProgress"/>
- <param name="status" type="org.apache.hadoop.mapred.TaskStatus"/>
- <doc>
- <![CDATA[A taskid assigned to this JobInProgress has reported in successfully.]]>
- </doc>
- </method>
- <method name="kill"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Kill the job and all its component tasks. This method should be called from
- jobtracker and should return fast as it locks the jobtracker.]]>
- </doc>
- </method>
- <method name="failedTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskInProgress"/>
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="reason" type="java.lang.String"/>
- <param name="phase" type="org.apache.hadoop.mapred.TaskStatus.Phase"/>
- <param name="state" type="org.apache.hadoop.mapred.TaskStatus.State"/>
- <param name="trackerName" type="java.lang.String"/>
- <doc>
- <![CDATA[Fail a task with a given reason, but without a status object.
-
- Assuming {@link JobTracker} is locked on entry.
-
- @param tip The task's tip
- @param taskid The task id
- @param reason The reason that the task failed
- @param trackerName The task tracker the task failed on]]>
- </doc>
- </method>
- <method name="getTaskInProgress" return="org.apache.hadoop.mapred.TaskInProgress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tipid" type="org.apache.hadoop.mapred.TaskID"/>
- <doc>
- <![CDATA[Return the TaskInProgress that matches the tipid.]]>
- </doc>
- </method>
- <method name="findFinishedMap" return="org.apache.hadoop.mapred.TaskStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mapId" type="int"/>
- <doc>
- <![CDATA[Find the details of someplace where a map has finished
- @param mapId the id of the map
- @return the task status of the completed task]]>
- </doc>
- </method>
- <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fromEventId" type="int"/>
- <param name="maxEvents" type="int"/>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The JobID of this JobInProgress.]]>
- </doc>
- </method>
- <method name="getJobSubmitHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return submitHostName of this JobInProgress.]]>
- </doc>
- </method>
- <method name="getJobSubmitHostAddress" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return submitHostAddress of this JobInProgress.]]>
- </doc>
- </method>
- <method name="getSchedulingInfo" return="java.lang.Object"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setSchedulingInfo"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingInfo" type="java.lang.Object"/>
- </method>
- <field name="tokenStorage" type="org.apache.hadoop.security.Credentials"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[JobInProgress maintains all the info for keeping
- a Job on the straight and narrow. It keeps its JobProfile
- and its latest JobStatus, plus a set of tables for
- doing bookkeeping of its Tasks.
- ***********************************************************]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobInProgress -->
- <!-- start class org.apache.hadoop.mapred.JobInProgress.Counter -->
- <class name="JobInProgress.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobInProgress.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobInProgress.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="NUM_FAILED_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NUM_FAILED_REDUCES" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOTAL_LAUNCHED_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TOTAL_LAUNCHED_REDUCES" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OTHER_LOCAL_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DATA_LOCAL_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODEGROUP_LOCAL_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RACK_LOCAL_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SLOTS_MILLIS_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SLOTS_MILLIS_REDUCES" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FALLOW_SLOTS_MILLIS_MAPS" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FALLOW_SLOTS_MILLIS_REDUCES" type="org.apache.hadoop.mapred.JobInProgress.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobInProgress.Counter -->
- <!-- start class org.apache.hadoop.mapred.JobLocalizer -->
- <class name="JobLocalizer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobLocalizer" type="org.apache.hadoop.mapred.JobConf, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="JobLocalizer" type="org.apache.hadoop.mapred.JobConf, java.lang.String, java.lang.String, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="createLocalDirs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createUserDirs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize the local directories for a particular user on this TT. This
- involves creation and setting permissions of the following directories
- <ul>
- <li>$mapred.local.dir/taskTracker/$user</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache</li>
- <li>$mapred.local.dir/taskTracker/$user/distcache</li>
- </ul>]]>
- </doc>
- </method>
- <method name="createJobDirs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Prepare the job directories for a given job. To be called by the job
- localization code, only if the job is not already localized.
- <br>
- Here, we set 700 permissions on the job directories created on all disks.
- This we do so as to avoid any misuse by other users till the time
- {@link TaskController#initializeJob} is run at a
- later time to set proper private permissions on the job directories. <br>]]>
- </doc>
- </method>
- <method name="initializeJobLogDir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create job log directory and set appropriate permissions for the directory.]]>
- </doc>
- </method>
- <method name="downloadPrivateCache" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Download the parts of the distributed cache that are private.
- @param conf the job's configuration
- @throws IOException
- @return the size of the archive objects]]>
- </doc>
- </method>
- <method name="localizeJobFiles"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="jConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="localJobTokenFile" type="org.apache.hadoop.fs.Path"/>
- <param name="taskTracker" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="localizeJobFiles"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="jConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="localJobFile" type="org.apache.hadoop.fs.Path"/>
- <param name="localJobTokenFile" type="org.apache.hadoop.fs.Path"/>
- <param name="taskTracker" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="createWorkDir"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jConf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="findCredentials" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="runSetup" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- <param name="localJobTokenFile" type="org.apache.hadoop.fs.Path"/>
- <param name="taskTracker" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="writeLocalJobFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobFile" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the task specific job-configuration file.
- @throws IOException]]>
- </doc>
- </method>
- <field name="ttConf" type="org.apache.hadoop.mapred.JobConf"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="JOB_LOCAL_CTXT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Internal class responsible for initializing the job, not intended for users.
- Creates the following hierarchy:
- <li>$mapred.local.dir/taskTracker/$user</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache/$jobid/work</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache/$jobid/jars</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache/$jobid/jars/job.jar</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache/$jobid/job.xml</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache/$jobid/jobToken</li>
- <li>$mapred.local.dir/taskTracker/$user/distcache</li>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobLocalizer -->
- <!-- start class org.apache.hadoop.mapred.JobPriority -->
- <class name="JobPriority" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobPriority[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="VERY_HIGH" type="org.apache.hadoop.mapred.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HIGH" type="org.apache.hadoop.mapred.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NORMAL" type="org.apache.hadoop.mapred.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOW" type="org.apache.hadoop.mapred.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VERY_LOW" type="org.apache.hadoop.mapred.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Used to describe the priority of the running job.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobPriority -->
- <!-- start class org.apache.hadoop.mapred.JobProfile -->
- <class name="JobProfile" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="JobProfile"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct an empty {@link JobProfile}.]]>
- </doc>
- </constructor>
- <constructor name="JobProfile" type="java.lang.String, org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a {@link JobProfile} the userid, jobid,
- job config-file, job-details url and job name.
-
- @param user userid of the person who submitted the job.
- @param jobid id of the job.
- @param jobFile job configuration file.
- @param url link to the web-ui for details of the job.
- @param name user-specified job name.]]>
- </doc>
- </constructor>
- <constructor name="JobProfile" type="java.lang.String, org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a {@link JobProfile} the userid, jobid,
- job config-file, job-details url and job name.
-
- @param user userid of the person who submitted the job.
- @param jobid id of the job.
- @param jobFile job configuration file.
- @param url link to the web-ui for details of the job.
- @param name user-specified job name.
- @param queueName name of the queue to which the job is submitted]]>
- </doc>
- </constructor>
- <constructor name="JobProfile" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="use JobProfile(String, JobID, String, String, String) instead">
- <doc>
- <![CDATA[@deprecated use JobProfile(String, JobID, String, String, String) instead]]>
- </doc>
- </constructor>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user id.]]>
- </doc>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job id.]]>
- </doc>
- </method>
- <method name="getJobId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use getJobID() instead">
- <doc>
- <![CDATA[@deprecated use getJobID() instead]]>
- </doc>
- </method>
- <method name="getJobFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configuration file for the job.]]>
- </doc>
- </method>
- <method name="getURL" return="java.net.URL"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the link to the web-ui for details of the job.]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-specified job name.]]>
- </doc>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the queue to which the job is submitted.
- @return name of the queue.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A JobProfile is a MapReduce primitive. Tracks a job,
- whether living or dead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobProfile -->
- <!-- start class org.apache.hadoop.mapred.JobQueueInfo -->
- <class name="JobQueueInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="JobQueueInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobQueueInfo" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new JobQueueInfo object using the queue name and the
- scheduling information passed.
-
- @param queueName Name of the job queue
- @param schedulingInfo Scheduling Information associated with the job
- queue]]>
- </doc>
- </constructor>
- <method name="setQueueName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the queue name of the JobQueueInfo
-
- @param queueName Name of the job queue.]]>
- </doc>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the queue name from JobQueueInfo
-
- @return queue name]]>
- </doc>
- </method>
- <method name="setSchedulingInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingInfo" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the scheduling information associated to particular job queue
-
- @param schedulingInfo]]>
- </doc>
- </method>
- <method name="getSchedulingInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the scheduling information associated to particular job queue.
- If nothing is set would return <b>"N/A"</b>
-
- @return Scheduling information associated to particular Job Queue]]>
- </doc>
- </method>
- <method name="setQueueState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="state" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the state of the queue
- @param state state of the queue.]]>
- </doc>
- </method>
- <method name="getQueueState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the queue state
- @return the queue state.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Class that contains the information regarding the Job Queues which are
- maintained by the Hadoop Map/Reduce framework.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobQueueInfo -->
- <!-- start class org.apache.hadoop.mapred.JobStatus -->
- <class name="JobStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="JobStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job status object for a given jobid.
- @param jobid The jobid of the job
- @param mapProgress The progress made on the maps
- @param reduceProgress The progress made on the reduces
- @param cleanupProgress The progress made on cleanup
- @param runState The current state of the job]]>
- </doc>
- </constructor>
- <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job status object for a given jobid.
- @param jobid The jobid of the job
- @param mapProgress The progress made on the maps
- @param reduceProgress The progress made on the reduces
- @param runState The current state of the job]]>
- </doc>
- </constructor>
- <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, int, org.apache.hadoop.mapred.JobPriority"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job status object for a given jobid.
- @param jobid The jobid of the job
- @param mapProgress The progress made on the maps
- @param reduceProgress The progress made on the reduces
- @param runState The current state of the job
- @param jp Priority of the job.]]>
- </doc>
- </constructor>
- <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, float, int, org.apache.hadoop.mapred.JobPriority"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job status object for a given jobid.
- @param jobid The jobid of the job
- @param setupProgress The progress made on the setup
- @param mapProgress The progress made on the maps
- @param reduceProgress The progress made on the reduces
- @param cleanupProgress The progress made on the cleanup
- @param runState The current state of the job
- @param jp Priority of the job.]]>
- </doc>
- </constructor>
- <method name="getJobRunState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="state" type="int"/>
- <doc>
- <![CDATA[Helper method to get human-readable state of the job.
- @param state job state
- @return human-readable state of the job]]>
- </doc>
- </method>
- <method name="getJobId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use getJobID instead">
- <doc>
- <![CDATA[@deprecated use getJobID instead]]>
- </doc>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The jobid of the Job]]>
- </doc>
- </method>
- <method name="mapProgress" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Percentage of progress in maps]]>
- </doc>
- </method>
- <method name="setJobACLs"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="acls" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the job acls
-
- @param acls {@link Map} from {@link JobACL} to {@link AccessControlList}]]>
- </doc>
- </method>
- <method name="cleanupProgress" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Percentage of progress in cleanup]]>
- </doc>
- </method>
- <method name="setupProgress" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Percentage of progress in setup]]>
- </doc>
- </method>
- <method name="reduceProgress" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Percentage of progress in reduce]]>
- </doc>
- </method>
- <method name="getRunState" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return running state of the job]]>
- </doc>
- </method>
- <method name="setRunState"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="state" type="int"/>
- <doc>
- <![CDATA[Change the current run state of the job.]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return start time of the job]]>
- </doc>
- </method>
- <method name="clone" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUsername" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the username of the job]]>
- </doc>
- </method>
- <method name="getSchedulingInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the Scheduling information associated to a particular Job.
- @return the scheduling information of the job]]>
- </doc>
- </method>
- <method name="getFailureInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[gets any available info on the reason of failure of the job.
- @return diagnostic information on why a job might have failed.]]>
- </doc>
- </method>
- <method name="setFailureInfo"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="failureInfo" type="java.lang.String"/>
- <doc>
- <![CDATA[set the reason for failuire of this job
- @param failureInfo the reason for failure of this job.]]>
- </doc>
- </method>
- <method name="setSchedulingInfo"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingInfo" type="java.lang.String"/>
- <doc>
- <![CDATA[Used to set the scheduling information associated to a particular Job.
-
- @param schedulingInfo Scheduling information of the job]]>
- </doc>
- </method>
- <method name="getJobACLs" return="java.util.Map"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the acls for Job.
-
- @return a {@link Map} from {@link JobACL} to {@link AccessControlList}]]>
- </doc>
- </method>
- <method name="getJobPriority" return="org.apache.hadoop.mapred.JobPriority"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the priority of the job
- @return job priority]]>
- </doc>
- </method>
- <method name="setJobPriority"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jp" type="org.apache.hadoop.mapred.JobPriority"/>
- <doc>
- <![CDATA[Set the priority of the job, defaulting to NORMAL.
- @param jp new job priority]]>
- </doc>
- </method>
- <method name="isJobComplete" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the status is for a completed job.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="RUNNING" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUCCEEDED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PREP" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Describes the current status of a job.
-
- @see JobProfile for some more information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobStatus -->
- <!-- start class org.apache.hadoop.mapred.JobTracker -->
- <class name="JobTracker" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.MRConstants"/>
- <implements name="org.apache.hadoop.mapred.InterTrackerProtocol"/>
- <implements name="org.apache.hadoop.mapred.JobSubmissionProtocol"/>
- <implements name="org.apache.hadoop.mapred.TaskTrackerManager"/>
- <implements name="org.apache.hadoop.security.RefreshUserMappingsProtocol"/>
- <implements name="org.apache.hadoop.security.authorize.RefreshAuthorizationPolicyProtocol"/>
- <implements name="org.apache.hadoop.mapred.AdminOperationsProtocol"/>
- <implements name="org.apache.hadoop.mapred.JobTrackerMXBean"/>
- <method name="getClock" return="org.apache.hadoop.mapred.Clock"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="startTracker" return="org.apache.hadoop.mapred.JobTracker"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Start the JobTracker with given configuration.
-
- The conf will be modified to reflect the actual ports on which
- the JobTracker is up and running if the user passes the port as
- <code>zero</code>.
-
- @param conf configuration for the JobTracker.
- @throws IOException]]>
- </doc>
- </method>
- <method name="startTracker" return="org.apache.hadoop.mapred.JobTracker"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="identifier" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="startTracker" return="org.apache.hadoop.mapred.JobTracker"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="identifier" type="java.lang.String"/>
- <param name="initialize" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="stopTracker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProtocolVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.String"/>
- <param name="clientVersion" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getDelegationTokenSecretManager" return="org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenSecretManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hasRestarted" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the JT has restarted]]>
- </doc>
- </method>
- <method name="hasRecovered" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the JT has recovered upon restart]]>
- </doc>
- </method>
- <method name="getRecoveryDuration" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long the jobtracker took to recover from restart.]]>
- </doc>
- </method>
- <method name="getAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="offerService"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Run forever]]>
- </doc>
- </method>
- <method name="getTotalSubmissions" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobTrackerMachine" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTrackerIdentifier" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the unique identifier (ie. timestamp) of this job tracker start.
- @return a string with a unique identifier]]>
- </doc>
- </method>
- <method name="getTrackerPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInfoPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="runningJobs" return="java.util.Vector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRunningJobs" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Version that is called from a timer thread, and therefore needs to be
- careful to synchronize.]]>
- </doc>
- </method>
- <method name="failedJobs" return="java.util.Vector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="completedJobs" return="java.util.Vector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="taskTrackers" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all the task trackers in the cluster
-
- @return {@link Collection} of {@link TaskTrackerStatus}]]>
- </doc>
- </method>
- <method name="activeTaskTrackers" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the active task tracker statuses in the cluster
-
- @return {@link Collection} of active {@link TaskTrackerStatus}]]>
- </doc>
- </method>
- <method name="taskTrackerNames" return="java.util.List"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the active, blacklisted, and graylisted task tracker names in the
- cluster. The first element in the returned list contains the list of
- active tracker names; the second element in the returned list contains
- the list of blacklisted tracker names; and the third contains the list
- of graylisted tracker names. Note that the blacklist is disjoint
- from the active list, but the graylist is not: initially, graylisted
- trackers are still active and therefore will appear in both lists.
- (Graylisted trackers can later be blacklisted, in which case they'll
- be removed from the active list and added to the blacklist, but they
- remain on the graylist in this case. Blacklisting comes about via the
- health-check script, while graylisting is heuristically based on the
- number of per-job blacklistings in a specified time interval.)]]>
- </doc>
- </method>
- <method name="blacklistedTaskTrackers" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the statuses of the blacklisted task trackers in the cluster.
- @return {@link Collection} of blacklisted {@link TaskTrackerStatus}]]>
- </doc>
- </method>
- <method name="graylistedTaskTrackers" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the statuses of the graylisted task trackers in the cluster.
- @return {@link Collection} of graylisted {@link TaskTrackerStatus}]]>
- </doc>
- </method>
- <method name="isBlacklisted" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackerID" type="java.lang.String"/>
- <doc>
- <![CDATA[Whether the tracker is blacklisted or not
- @param trackerID
- @return true if blacklisted, false otherwise]]>
- </doc>
- </method>
- <method name="isGraylisted" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackerID" type="java.lang.String"/>
- <doc>
- <![CDATA[Whether the tracker is graylisted or not
- @param trackerID
- @return true if graylisted, false otherwise]]>
- </doc>
- </method>
- <method name="getTaskTrackerStatus" return="org.apache.hadoop.mapred.TaskTrackerStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackerID" type="java.lang.String"/>
- </method>
- <method name="getTaskTracker" return="org.apache.hadoop.mapreduce.server.jobtracker.TaskTracker"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackerID" type="java.lang.String"/>
- </method>
- <method name="resolveAndAddToTopology" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="UnknownHostException" type="java.net.UnknownHostException"/>
- </method>
- <method name="getNodesAtMaxLevel" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a collection of nodes at the max level]]>
- </doc>
- </method>
- <method name="getParentNode" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="node" type="org.apache.hadoop.net.Node"/>
- <param name="level" type="int"/>
- </method>
- <method name="getNode" return="org.apache.hadoop.net.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Return the Node in the network topology that corresponds to the hostname]]>
- </doc>
- </method>
- <method name="getNumTaskCacheLevels" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumResolvedTaskTrackers" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumberOfUniqueHosts" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isNodeGroupAware" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addJobInProgressListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="listener" type="org.apache.hadoop.mapred.JobInProgressListener"/>
- </method>
- <method name="removeJobInProgressListener"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="listener" type="org.apache.hadoop.mapred.JobInProgressListener"/>
- </method>
- <method name="getQueueManager" return="org.apache.hadoop.mapred.QueueManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the {@link QueueManager} associated with the JobTracker.]]>
- </doc>
- </method>
- <method name="getVIVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="heartbeat" return="org.apache.hadoop.mapred.HeartbeatResponse"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <param name="restarted" type="boolean"/>
- <param name="initialContact" type="boolean"/>
- <param name="acceptNewTasks" type="boolean"/>
- <param name="responseId" type="short"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The periodic heartbeat mechanism between the {@link TaskTracker} and
- the {@link JobTracker}.
-
- The {@link JobTracker} processes the status information sent by the
- {@link TaskTracker} and responds with instructions to start/stop
- tasks or jobs, and also 'reset' instructions during contingencies.]]>
- </doc>
- </method>
- <method name="getNextHeartbeatInterval" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Calculates next heartbeat interval using cluster size.
- Heartbeat interval is incremented by 1 second for every 100 nodes by default.
- @return next heartbeat interval.]]>
- </doc>
- </method>
- <method name="getFilesystemName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Grab the local fs name]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns a handle to the JobTracker's Configuration]]>
- </doc>
- </method>
- <method name="reportTaskTrackerError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskTracker" type="java.lang.String"/>
- <param name="errorClass" type="java.lang.String"/>
- <param name="errorMessage" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getNewJobId" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Allocates a new JobId string.]]>
- </doc>
- </method>
- <method name="submitJob" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="jobSubmitDir" type="java.lang.String"/>
- <param name="ts" type="org.apache.hadoop.security.Credentials"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[JobTracker.submitJob() kicks off a new job.
- Create a 'JobInProgress' object, which contains both JobProfile
- and JobStatus. Those two sub-objects are sometimes shipped outside
- of the JobTracker. But JobInProgress adds info that's useful for
- the JobTracker alone.]]>
- </doc>
- </method>
- <method name="getStagingAreaDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getStagingAreaDir()]]>
- </doc>
- </method>
- <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getClusterStatus(boolean)}">
- <doc>
- <![CDATA[@deprecated use {@link #getClusterStatus(boolean)}]]>
- </doc>
- </method>
- <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="detailed" type="boolean"/>
- </method>
- <method name="getClusterMetrics" return="org.apache.hadoop.mapreduce.ClusterMetrics"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="killJob"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see JobSubmissionProtocol#killJob]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Discard a current delegation token.]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get a new delegation token.]]>
- </doc>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Renew a delegation token to extend its lifetime.]]>
- </doc>
- </method>
- <method name="initJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobInProgress"/>
- </method>
- <method name="failJob"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobInProgress"/>
- <doc>
- <![CDATA[Fail a job and inform the listeners. Other components in the framework
- should use this to fail a job.]]>
- </doc>
- </method>
- <method name="setJobPriority"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="priority" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getJobProfile" return="org.apache.hadoop.mapred.JobProfile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getJobStatus" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getJobCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCleanupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSetupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="fromEventId" type="int"/>
- <param name="maxEvents" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTaskDiagnostics" return="java.lang.String[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the diagnostics for a given task
- @param taskId the id of the task
- @return an array of the diagnostic messages]]>
- </doc>
- </method>
- <method name="getTip" return="org.apache.hadoop.mapred.TaskInProgress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tipid" type="org.apache.hadoop.mapred.TaskID"/>
- <doc>
- <![CDATA[Returns specified TaskInProgress, or null.]]>
- </doc>
- </method>
- <method name="killTask" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="shouldFail" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see JobSubmissionProtocol#killTask(TaskAttemptID, boolean)]]>
- </doc>
- </method>
- <method name="getAssignedTracker" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <doc>
- <![CDATA[Get tracker name for a given task id.
- @param taskId the name of the task
- @return The name of the task tracker]]>
- </doc>
- </method>
- <method name="jobsToComplete" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAllJobs" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see JobSubmissionProtocol#getAllJobs()]]>
- </doc>
- </method>
- <method name="getSystemDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getSystemDir()]]>
- </doc>
- </method>
- <method name="getQueueAdmins" return="org.apache.hadoop.security.authorize.AccessControlList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getQueueAdmins(String)]]>
- </doc>
- </method>
- <method name="getJob" return="org.apache.hadoop.mapred.JobInProgress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="refreshNodes"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rereads the config to get hosts and exclude list file names.
- Rereads the files to update the hosts and exclude lists.]]>
- </doc>
- </method>
- <method name="getLocalJobFilePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <doc>
- <![CDATA[Get the localized job file path on the job trackers local file system
- @param jobId id of the job
- @return the path of the job conf file on the local file system]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Start the JobTracker process. This is used only for debugging. As a rule,
- JobTracker should be run as part of the DFS Namenode process.]]>
- </doc>
- </method>
- <method name="getQueues" return="org.apache.hadoop.mapred.JobQueueInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQueueInfo" return="org.apache.hadoop.mapred.JobQueueInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getJobsFromQueue" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQueueAclsForCurrentUser" return="org.apache.hadoop.mapred.QueueAclsInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="refreshServiceAcl"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="refreshSuperUserGroupsConfiguration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="refreshUserToGroupsMappings"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="refreshQueues"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getReasonsForBlacklisting" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- </method>
- <method name="getReasonsForGraylisting" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getConfigVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getThreadCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSummaryJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAliveNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getBlacklistedNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getGraylistedNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getQueueInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setSafeMode" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="safeModeAction" type="org.apache.hadoop.mapred.JobTracker.SafeModeAction"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="isInSafeMode" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="MAX_USER_JOBCONF_SIZE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the config key for max user jobconf size]]>
- </doc>
- </field>
- <field name="DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JT_USER_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JT_KEYTAB_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_CLUSTER_MAP_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_CLUSTER_REDUCE_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_CLUSTER_MAX_MAP_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAPRED_CLUSTER_MAX_REDUCE_MEMORY_MB_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[JobTracker is the central location for submitting and
- tracking MR jobs in a network environment.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobTracker -->
- <!-- start class org.apache.hadoop.mapred.JobTracker.IllegalStateException -->
- <class name="JobTracker.IllegalStateException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTracker.IllegalStateException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A client tried to submit a job before the Job Tracker was ready.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobTracker.IllegalStateException -->
- <!-- start class org.apache.hadoop.mapred.JobTracker.SafeModeAction -->
- <class name="JobTracker.SafeModeAction" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobTracker.SafeModeAction[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobTracker.SafeModeAction"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SAFEMODE_LEAVE" type="org.apache.hadoop.mapred.JobTracker.SafeModeAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SAFEMODE_ENTER" type="org.apache.hadoop.mapred.JobTracker.SafeModeAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SAFEMODE_GET" type="org.apache.hadoop.mapred.JobTracker.SafeModeAction"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[JobTracker SafeMode]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobTracker.SafeModeAction -->
- <!-- start class org.apache.hadoop.mapred.JobTracker.State -->
- <class name="JobTracker.State" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.JobTracker.State[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.JobTracker.State"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="INITIALIZING" type="org.apache.hadoop.mapred.JobTracker.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.mapred.JobTracker.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobTracker.State -->
- <!-- start interface org.apache.hadoop.mapred.JobTrackerMXBean -->
- <interface name="JobTrackerMXBean" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return hostname of the jobtracker]]>
- </doc>
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return version of the code base]]>
- </doc>
- </method>
- <method name="getConfigVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the config version (from a config property)]]>
- </doc>
- </method>
- <method name="getThreadCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return number of threads of the jobtracker jvm]]>
- </doc>
- </method>
- <method name="getSummaryJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the summary info in json]]>
- </doc>
- </method>
- <method name="getAliveNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the alive nodes info in json]]>
- </doc>
- </method>
- <method name="getBlacklistedNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the blacklisted nodes info in json]]>
- </doc>
- </method>
- <method name="getGraylistedNodesInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the graylisted nodes info in json]]>
- </doc>
- </method>
- <method name="getQueueInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the queue info json]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MXBean interface for JobTrackerInfo]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.JobTrackerMXBean -->
- <!-- start class org.apache.hadoop.mapred.JobTrackerNotYetInitializedException -->
- <class name="JobTrackerNotYetInitializedException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTrackerNotYetInitializedException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when the JobTracker is still initializing and
- not yet operational.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.JobTrackerNotYetInitializedException -->
- <!-- start class org.apache.hadoop.mapred.JvmTask -->
- <class name="JvmTask" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="JvmTask" type="org.apache.hadoop.mapred.Task, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JvmTask"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTask" return="org.apache.hadoop.mapred.Task"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="shouldDie" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.JvmTask -->
- <!-- start class org.apache.hadoop.mapred.KeyValueLineRecordReader -->
- <class name="KeyValueLineRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="KeyValueLineRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createKey" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="findSeparator" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <param name="sep" type="byte"/>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read key/value pair in a line.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class treats a line in the input as a key/value pair separated by a
- separator character. The separator can be specified in config file
- under the attribute name key.value.separator.in.input.line. The default
- separator is the tab character ('\t').]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.KeyValueLineRecordReader -->
- <!-- start class org.apache.hadoop.mapred.KeyValueTextInputFormat -->
- <class name="KeyValueTextInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="KeyValueTextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
- Either linefeed or carriage-return are used to signal end of line. Each line
- is divided into key and value parts by a separator byte. If no such a byte
- exists, the key will be the entire line and value will be empty.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.KeyValueTextInputFormat -->
- <!-- start class org.apache.hadoop.mapred.LineRecordReader -->
- <class name="LineRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="LineRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="LineRecordReader" type="java.io.InputStream, long, long, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="LineRecordReader" type="java.io.InputStream, long, long, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="createKey" return="org.apache.hadoop.io.LongWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.LongWritable"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a line.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the progress within the split]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Treats keys as offset in file and value as line.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.LineRecordReader -->
- <!-- start class org.apache.hadoop.mapred.LineRecordReader.LineReader -->
- <class name="LineRecordReader.LineReader" extends="org.apache.hadoop.util.LineReader"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.util.LineReader} instead.">
- <constructor name="LineRecordReader.LineReader" type="java.io.InputStream, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <doc>
- <![CDATA[A class that provides a line reader from an input stream.
- @deprecated Use {@link org.apache.hadoop.util.LineReader} instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.LineRecordReader.LineReader -->
- <!-- start class org.apache.hadoop.mapred.LocalJobRunner -->
- <class name="LocalJobRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobSubmissionProtocol"/>
- <constructor name="LocalJobRunner" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getProtocolVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.String"/>
- <param name="clientVersion" type="long"/>
- </method>
- <method name="getNewJobId" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="submitJob" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="jobSubmitDir" type="java.lang.String"/>
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="killJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="setJobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- <param name="jp" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="killTask" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="shouldFail" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Throws {@link UnsupportedOperationException}]]>
- </doc>
- </method>
- <method name="getJobProfile" return="org.apache.hadoop.mapred.JobProfile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getCleanupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getSetupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getJobStatus" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getJobCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- </method>
- <method name="getFilesystemName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="detailed" type="boolean"/>
- </method>
- <method name="jobsToComplete" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
- <param name="fromEventId" type="int"/>
- <param name="maxEvents" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getAllJobs" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskDiagnostics" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the diagnostic information for a particular task in the given job.
- To be implemented]]>
- </doc>
- </method>
- <method name="getSystemDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getSystemDir()]]>
- </doc>
- </method>
- <method name="getQueueAdmins" return="org.apache.hadoop.security.authorize.AccessControlList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getQueueAdmins()]]>
- </doc>
- </method>
- <method name="getStagingAreaDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getStagingAreaDir()]]>
- </doc>
- </method>
- <method name="getJobsFromQueue" return="org.apache.hadoop.mapred.JobStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQueues" return="org.apache.hadoop.mapred.JobQueueInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQueueInfo" return="org.apache.hadoop.mapred.JobQueueInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getQueueAclsForCurrentUser" return="org.apache.hadoop.mapred.QueueAclsInfo[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setLocalMaxRunningMaps"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="maxMaps" type="int"/>
- <doc>
- <![CDATA[Set the max number of map tasks to run concurrently in the LocalJobRunner.
- @param job the job to configure
- @param maxMaps the maximum number of map tasks to allow.]]>
- </doc>
- </method>
- <method name="getLocalMaxRunningMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[@return the max number of map tasks to run concurrently in the
- LocalJobRunner.]]>
- </doc>
- </method>
- <method name="cancelDelegationToken"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="renewDelegationToken" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOCAL_MAX_MAPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Implements MapReduce locally, in-process, for debugging.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.LocalJobRunner -->
- <!-- start class org.apache.hadoop.mapred.MapFileOutputFormat -->
- <class name="MapFileOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapFileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getReaders" return="org.apache.hadoop.io.MapFile.Reader[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open the output generated by this format.]]>
- </doc>
- </method>
- <method name="getEntry" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readers" type="org.apache.hadoop.io.MapFile.Reader[]"/>
- <param name="partitioner" type="org.apache.hadoop.mapred.Partitioner"/>
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get an entry from output generated by this class.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes {@link MapFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MapFileOutputFormat -->
- <!-- start interface org.apache.hadoop.mapred.Mapper -->
- <interface name="Mapper" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <implements name="org.apache.hadoop.io.Closeable"/>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Maps a single input key/value pair into an intermediate key/value pair.
-
- <p>Output pairs need not be of the same types as input pairs. A given
- input pair may map to zero or many output pairs. Output pairs are
- collected with calls to
- {@link OutputCollector#collect(Object,Object)}.</p>
- <p>Applications can use the {@link Reporter} provided to report progress
- or just indicate that they are alive. In scenarios where the application
- takes an insignificant amount of time to process individual key/value
- pairs, this is crucial since the framework might assume that the task has
- timed-out and kill that task. The other way of avoiding this is to set
- <a href="{@docRoot}/../mapred-default.html#mapred.task.timeout">
- mapred.task.timeout</a> to a high-enough value (or even zero for no
- time-outs).</p>
-
- @param key the input key.
- @param value the input value.
- @param output collects mapped keys and values.
- @param reporter facility to report progress.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Maps input key/value pairs to a set of intermediate key/value pairs.
-
- <p>Maps are the individual tasks which transform input records into a
- intermediate records. The transformed intermediate records need not be of
- the same type as the input records. A given input pair may map to zero or
- many output pairs.</p>
-
- <p>The Hadoop Map-Reduce framework spawns one map task for each
- {@link InputSplit} generated by the {@link InputFormat} for the job.
- <code>Mapper</code> implementations can access the {@link JobConf} for the
- job via the {@link JobConfigurable#configure(JobConf)} and initialize
- themselves. Similarly they can use the {@link Closeable#close()} method for
- de-initialization.</p>
-
- <p>The framework then calls
- {@link #map(Object, Object, OutputCollector, Reporter)}
- for each key/value pair in the <code>InputSplit</code> for that task.</p>
-
- <p>All intermediate values associated with a given output key are
- subsequently grouped by the framework, and passed to a {@link Reducer} to
- determine the final output. Users can control the grouping by specifying
- a <code>Comparator</code> via
- {@link JobConf#setOutputKeyComparatorClass(Class)}.</p>
- <p>The grouped <code>Mapper</code> outputs are partitioned per
- <code>Reducer</code>. Users can control which keys (and hence records) go to
- which <code>Reducer</code> by implementing a custom {@link Partitioner}.
-
- <p>Users can optionally specify a <code>combiner</code>, via
- {@link JobConf#setCombinerClass(Class)}, to perform local aggregation of the
- intermediate outputs, which helps to cut down the amount of data transferred
- from the <code>Mapper</code> to the <code>Reducer</code>.
-
- <p>The intermediate, grouped outputs are always stored in
- {@link SequenceFile}s. Applications can specify if and how the intermediate
- outputs are to be compressed and which {@link CompressionCodec}s are to be
- used via the <code>JobConf</code>.</p>
-
- <p>If the job has
- <a href="{@docRoot}/org/apache/hadoop/mapred/JobConf.html#ReducerNone">zero
- reduces</a> then the output of the <code>Mapper</code> is directly written
- to the {@link FileSystem} without grouping by keys.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyMapper<K extends WritableComparable, V extends Writable>
- extends MapReduceBase implements Mapper<K, V, K, V> {
-
- static enum MyCounters { NUM_RECORDS }
-
- private String mapTaskId;
- private String inputFile;
- private int noRecords = 0;
-
- public void configure(JobConf job) {
- mapTaskId = job.get("mapred.task.id");
- inputFile = job.get("map.input.file");
- }
-
- public void map(K key, V val,
- OutputCollector<K, V> output, Reporter reporter)
- throws IOException {
- // Process the <key, value> pair (assume this takes a while)
- // ...
- // ...
-
- // Let the framework know that we are alive, and kicking!
- // reporter.progress();
-
- // Process some more
- // ...
- // ...
-
- // Increment the no. of <key, value> pairs processed
- ++noRecords;
- // Increment counters
- reporter.incrCounter(NUM_RECORDS, 1);
-
- // Every 100 records update application-level status
- if ((noRecords%100) == 0) {
- reporter.setStatus(mapTaskId + " processed " + noRecords +
- " from input-file: " + inputFile);
- }
-
- // Output the result
- output.collect(key, val);
- }
- }
- </pre></blockquote></p>
- <p>Applications may write a custom {@link MapRunnable} to exert greater
- control on map processing e.g. multi-threaded <code>Mapper</code>s etc.</p>
-
- @see JobConf
- @see InputFormat
- @see Partitioner
- @see Reducer
- @see MapReduceBase
- @see MapRunnable
- @see SequenceFile]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.Mapper -->
- <!-- start class org.apache.hadoop.mapred.MapReduceBase -->
- <class name="MapReduceBase" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Closeable"/>
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="MapReduceBase"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Default implementation that does nothing.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Default implementation that does nothing.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Base class for {@link Mapper} and {@link Reducer} implementations.
-
- <p>Provides default no-op implementations for a few methods, most non-trivial
- applications need to override some of them.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MapReduceBase -->
- <!-- start class org.apache.hadoop.mapred.MapReducePolicyProvider -->
- <class name="MapReducePolicyProvider" extends="org.apache.hadoop.security.authorize.PolicyProvider"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapReducePolicyProvider"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getServices" return="org.apache.hadoop.security.authorize.Service[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[{@link PolicyProvider} for Map-Reduce protocols.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MapReducePolicyProvider -->
- <!-- start interface org.apache.hadoop.mapred.MapRunnable -->
- <interface name="MapRunnable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Start mapping input <tt><key, value></tt> pairs.
-
- <p>Mapping of input records to output records is complete when this method
- returns.</p>
-
- @param input the {@link RecordReader} to read the input records.
- @param output the {@link OutputCollector} to collect the outputrecords.
- @param reporter {@link Reporter} to report progress, status-updates etc.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Expert: Generic interface for {@link Mapper}s.
-
- <p>Custom implementations of <code>MapRunnable</code> can exert greater
- control on map processing e.g. multi-threaded, asynchronous mappers etc.</p>
-
- @see Mapper]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.MapRunnable -->
- <!-- start class org.apache.hadoop.mapred.MapRunner -->
- <class name="MapRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.MapRunnable"/>
- <constructor name="MapRunner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getMapper" return="org.apache.hadoop.mapred.Mapper"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Default {@link MapRunnable} implementation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MapRunner -->
- <!-- start class org.apache.hadoop.mapred.MapTaskCompletionEventsUpdate -->
- <class name="MapTaskCompletionEventsUpdate" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="MapTaskCompletionEventsUpdate"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="MapTaskCompletionEventsUpdate" type="org.apache.hadoop.mapred.TaskCompletionEvent[], boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="shouldReset" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A class that represents the communication between the tasktracker and child
- tasks w.r.t the map task completion events. It also indicates whether the
- child task should reset its events index.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MapTaskCompletionEventsUpdate -->
- <!-- start class org.apache.hadoop.mapred.MultiFileInputFormat -->
- <class name="MultiFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.mapred.lib.CombineFileInputFormat} instead">
- <constructor name="MultiFileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An abstract {@link InputFormat} that returns {@link MultiFileSplit}'s
- in {@link #getSplits(JobConf, int)} method. Splits are constructed from
- the files under the input paths. Each split returned contains <i>nearly</i>
- equal content length. <br>
- Subclasses implement {@link #getRecordReader(InputSplit, JobConf, Reporter)}
- to construct <code>RecordReader</code>'s for <code>MultiFileSplit</code>'s.
- @see MultiFileSplit
- @deprecated Use {@link org.apache.hadoop.mapred.lib.CombineFileInputFormat} instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MultiFileInputFormat -->
- <!-- start class org.apache.hadoop.mapred.MultiFileSplit -->
- <class name="MultiFileSplit" extends="org.apache.hadoop.mapred.lib.CombineFileSplit"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link org.apache.hadoop.mapred.lib.CombineFileSplit} instead">
- <constructor name="MultiFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A sub-collection of input files. Unlike {@link FileSplit}, MultiFileSplit
- class does not represent a split of a file, but a split of input files
- into smaller sets. The atomic unit of split is a file. <br>
- MultiFileSplit can be used to implement {@link RecordReader}'s, with
- reading one record per file.
- @see FileSplit
- @see MultiFileInputFormat
- @deprecated Use {@link org.apache.hadoop.mapred.lib.CombineFileSplit} instead]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.MultiFileSplit -->
- <!-- start class org.apache.hadoop.mapred.Operation -->
- <class name="Operation" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.Operation[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.Operation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="VIEW_JOB_COUNTERS" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VIEW_JOB_DETAILS" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VIEW_TASK_LOGS" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILL_JOB" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAIL_TASK" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILL_TASK" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SET_JOB_PRIORITY" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUBMIT_JOB" type="org.apache.hadoop.mapred.Operation"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="qACLNeeded" type="org.apache.hadoop.mapred.QueueManager.QueueACL"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="jobACLNeeded" type="org.apache.hadoop.mapreduce.JobACL"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Generic operation that maps to the dependent set of ACLs that drive the
- authorization of the operation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Operation -->
- <!-- start interface org.apache.hadoop.mapred.OutputCollector -->
- <interface name="OutputCollector" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="collect"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Adds a key/value pair to the output.
- @param key the key to collect.
- @param value to value to collect.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Collects the <code><key, value></code> pairs output by {@link Mapper}s
- and {@link Reducer}s.
-
- <p><code>OutputCollector</code> is the generalization of the facility
- provided by the Map-Reduce framework to collect data output by either the
- <code>Mapper</code> or the <code>Reducer</code> i.e. intermediate outputs
- or the output of the job.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.OutputCollector -->
- <!-- start class org.apache.hadoop.mapred.OutputCommitter -->
- <class name="OutputCommitter" extends="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OutputCommitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setupJob"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For the framework to setup the job output during initialization
-
- @param jobContext Context of the job whose output is being written.
- @throws IOException if temporary output could not be created]]>
- </doc>
- </method>
- <method name="cleanupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #commitJob(JobContext)} or
- {@link #abortJob(JobContext, int)} instead">
- <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For cleaning up the job's output after job completion
- @deprecated use {@link #commitJob(JobContext)} or
- {@link #abortJob(JobContext, int)} instead]]>
- </doc>
- </method>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For committing job's output after successful job completion. Note that this
- is invoked for jobs with final run state as {@link JobStatus#SUCCEEDED}.
-
- @param jobContext Context of the job whose output is being written.
- @throws IOException]]>
- </doc>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
- <param name="status" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For cleaning up the job's output after job failure.
-
- @param jobContext Context of the job whose output is being written.
- @param status Final run state of the job, should be
- {@link JobStatus#KILLED} or {@link JobStatus#FAILED}
- @throws IOException]]>
- </doc>
- </method>
- <method name="setupTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets up output for the task.
-
- @param taskContext Context of the task whose output is being written.
- @throws IOException]]>
- </doc>
- </method>
- <method name="needsTaskCommit" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check whether task needs a commit
-
- @param taskContext
- @return true/false
- @throws IOException]]>
- </doc>
- </method>
- <method name="commitTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[To promote the task's temporary output to final output location
-
- The task's output is moved to the job's output directory.
-
- @param taskContext Context of the task whose output is being written.
- @throws IOException if commit is not]]>
- </doc>
- </method>
- <method name="abortTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Discard the task output
-
- @param taskContext
- @throws IOException]]>
- </doc>
- </method>
- <method name="setupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="cleanupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="runState" type="org.apache.hadoop.mapreduce.JobStatus.State"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="setupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="needsTaskCommit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="commitTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <method name="abortTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This method implements the new interface by calling the old method. Note
- that the input types are different between the new and old apis and this
- is a bridge between the two.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>OutputCommitter</code> describes the commit of task output for a
- Map-Reduce job.
- <p>The Map-Reduce framework relies on the <code>OutputCommitter</code> of
- the job to:<p>
- <ol>
- <li>
- Setup the job during initialization. For example, create the temporary
- output directory for the job during the initialization of the job.
- </li>
- <li>
- Cleanup the job after the job completion. For example, remove the
- temporary output directory after the job completion.
- </li>
- <li>
- Setup the task temporary output.
- </li>
- <li>
- Check whether a task needs a commit. This is to avoid the commit
- procedure if a task does not need commit.
- </li>
- <li>
- Commit of the task output.
- </li>
- <li>
- Discard the task commit.
- </li>
- </ol>
-
- @see FileOutputCommitter
- @see JobContext
- @see TaskAttemptContext]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.OutputCommitter -->
- <!-- start interface org.apache.hadoop.mapred.OutputFormat -->
- <interface name="OutputFormat" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the {@link RecordWriter} for the given job.
- @param ignored
- @param job configuration for the job whose output is being written.
- @param name the unique name for this part of the output.
- @param progress mechanism for reporting progress while writing to file.
- @return a {@link RecordWriter} to write the output for the job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check for validity of the output-specification for the job.
-
- <p>This is to validate the output specification for the job when it is
- a job is submitted. Typically checks that it does not already exist,
- throwing an exception when it already exists, so that output is not
- overwritten.</p>
- @param ignored
- @param job job configuration.
- @throws IOException when output should not be attempted]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>OutputFormat</code> describes the output-specification for a
- Map-Reduce job.
- <p>The Map-Reduce framework relies on the <code>OutputFormat</code> of the
- job to:<p>
- <ol>
- <li>
- Validate the output-specification of the job. For e.g. check that the
- output directory doesn't already exist.
- <li>
- Provide the {@link RecordWriter} implementation to be used to write out
- the output files of the job. Output files are stored in a
- {@link FileSystem}.
- </li>
- </ol>
-
- @see RecordWriter
- @see JobConf]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.OutputFormat -->
- <!-- start class org.apache.hadoop.mapred.OutputLogFilter -->
- <class name="OutputLogFilter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="Use
- {@link org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputLogFilter}
- instead.">
- <implements name="org.apache.hadoop.fs.PathFilter"/>
- <constructor name="OutputLogFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <doc>
- <![CDATA[This class filters log files from directory given
- It doesnt accept paths having _logs.
- This can be used to list paths of output directory as follows:
- Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,
- new OutputLogFilter()));
- @deprecated Use
- {@link org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputLogFilter}
- instead.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.OutputLogFilter -->
- <!-- start interface org.apache.hadoop.mapred.Partitioner -->
- <interface name="Partitioner" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numPartitions" type="int"/>
- <doc>
- <![CDATA[Get the paritition number for a given key (hence record) given the total
- number of partitions i.e. number of reduce-tasks for the job.
-
- <p>Typically a hash function on a all or a subset of the key.</p>
- @param key the key to be paritioned.
- @param value the entry value.
- @param numPartitions the total number of partitions.
- @return the partition number for the <code>key</code>.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Partitions the key space.
-
- <p><code>Partitioner</code> controls the partitioning of the keys of the
- intermediate map-outputs. The key (or a subset of the key) is used to derive
- the partition, typically by a hash function. The total number of partitions
- is the same as the number of reduce tasks for the job. Hence this controls
- which of the <code>m</code> reduce tasks the intermediate key (and hence the
- record) is sent for reduction.</p>
-
- @see Reducer]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.Partitioner -->
- <!-- start class org.apache.hadoop.mapred.QueueAclsInfo -->
- <class name="QueueAclsInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="QueueAclsInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor for QueueAclsInfo.]]>
- </doc>
- </constructor>
- <constructor name="QueueAclsInfo" type="java.lang.String, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a new QueueAclsInfo object using the queue name and the
- queue operations array
-
- @param queueName Name of the job queue
- @param operations queue operations]]>
- </doc>
- </constructor>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setQueueName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- </method>
- <method name="getOperations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Class to encapsulate Queue ACLs for a particular
- user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.QueueAclsInfo -->
- <!-- start class org.apache.hadoop.mapred.RawHistoryFileServlet -->
- <class name="RawHistoryFileServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RawHistoryFileServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="servletConfig" type="javax.servlet.ServletConfig"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- </method>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.RawHistoryFileServlet -->
- <!-- start interface org.apache.hadoop.mapred.RawKeyValueIterator -->
- <interface name="RawKeyValueIterator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getKey" return="org.apache.hadoop.io.DataInputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the current raw key.
-
- @return Gets the current raw key as a DataInputBuffer
- @throws IOException]]>
- </doc>
- </method>
- <method name="getValue" return="org.apache.hadoop.io.DataInputBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the current raw value.
-
- @return Gets the current raw value as a DataInputBuffer
- @throws IOException]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets up the current key and value (for getKey and getValue).
-
- @return <code>true</code> if there exists a key/value,
- <code>false</code> otherwise.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes the iterator so that the underlying streams can be closed.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getProgress" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the Progress object; this has a float (0.0 - 1.0)
- indicating the bytes processed by the iterator so far]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>RawKeyValueIterator</code> is an iterator used to iterate over
- the raw keys and values during sort/merge of intermediate data.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.RawKeyValueIterator -->
- <!-- start interface org.apache.hadoop.mapred.RecordReader -->
- <interface name="RecordReader" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reads the next key/value pair from the input for processing.
- @param key the key to read data into
- @param value the value to read data into
- @return true iff a key/value was read, false if at EOF]]>
- </doc>
- </method>
- <method name="createKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an object of the appropriate type to be used as a key.
-
- @return a new key object.]]>
- </doc>
- </method>
- <method name="createValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an object of the appropriate type to be used as a value.
-
- @return a new value object.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the current position in the input.
-
- @return the current position in the input.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close this {@link InputSplit} to future operations.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[How much of the input has the {@link RecordReader} consumed i.e.
- has been processed by?
-
- @return progress from <code>0.0</code> to <code>1.0</code>.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>RecordReader</code> reads <key, value> pairs from an
- {@link InputSplit}.
-
- <p><code>RecordReader</code>, typically, converts the byte-oriented view of
- the input, provided by the <code>InputSplit</code>, and presents a
- record-oriented view for the {@link Mapper} & {@link Reducer} tasks for
- processing. It thus assumes the responsibility of processing record
- boundaries and presenting the tasks with keys and values.</p>
-
- @see InputSplit
- @see InputFormat]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.RecordReader -->
- <!-- start interface org.apache.hadoop.mapred.RecordWriter -->
- <interface name="RecordWriter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes a key/value pair.
- @param key the key to write.
- @param value the value to write.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close this <code>RecordWriter</code> to future operations.
-
- @param reporter facility to report progress.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>RecordWriter</code> writes the output <key, value> pairs
- to an output file.
- <p><code>RecordWriter</code> implementations write the job outputs to the
- {@link FileSystem}.
-
- @see OutputFormat]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.RecordWriter -->
- <!-- start interface org.apache.hadoop.mapred.Reducer -->
- <interface name="Reducer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <implements name="org.apache.hadoop.io.Closeable"/>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<i>Reduces</i> values for a given key.
-
- <p>The framework calls this method for each
- <code><key, (list of values)></code> pair in the grouped inputs.
- Output values must be of the same type as input values. Input keys must
- not be altered. The framework will <b>reuse</b> the key and value objects
- that are passed into the reduce, therefore the application should clone
- the objects they want to keep a copy of. In many cases, all values are
- combined into zero or one value.
- </p>
-
- <p>Output pairs are collected with calls to
- {@link OutputCollector#collect(Object,Object)}.</p>
- <p>Applications can use the {@link Reporter} provided to report progress
- or just indicate that they are alive. In scenarios where the application
- takes an insignificant amount of time to process individual key/value
- pairs, this is crucial since the framework might assume that the task has
- timed-out and kill that task. The other way of avoiding this is to set
- <a href="{@docRoot}/../mapred-default.html#mapred.task.timeout">
- mapred.task.timeout</a> to a high-enough value (or even zero for no
- time-outs).</p>
-
- @param key the key.
- @param values the list of values to reduce.
- @param output to collect keys and combined values.
- @param reporter facility to report progress.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Reduces a set of intermediate values which share a key to a smaller set of
- values.
-
- <p>The number of <code>Reducer</code>s for the job is set by the user via
- {@link JobConf#setNumReduceTasks(int)}. <code>Reducer</code> implementations
- can access the {@link JobConf} for the job via the
- {@link JobConfigurable#configure(JobConf)} method and initialize themselves.
- Similarly they can use the {@link Closeable#close()} method for
- de-initialization.</p>
- <p><code>Reducer</code> has 3 primary phases:</p>
- <ol>
- <li>
-
- <h4 id="Shuffle">Shuffle</h4>
-
- <p><code>Reducer</code> is input the grouped output of a {@link Mapper}.
- In the phase the framework, for each <code>Reducer</code>, fetches the
- relevant partition of the output of all the <code>Mapper</code>s, via HTTP.
- </p>
- </li>
-
- <li>
- <h4 id="Sort">Sort</h4>
-
- <p>The framework groups <code>Reducer</code> inputs by <code>key</code>s
- (since different <code>Mapper</code>s may have output the same key) in this
- stage.</p>
-
- <p>The shuffle and sort phases occur simultaneously i.e. while outputs are
- being fetched they are merged.</p>
-
- <h5 id="SecondarySort">SecondarySort</h5>
-
- <p>If equivalence rules for keys while grouping the intermediates are
- different from those for grouping keys before reduction, then one may
- specify a <code>Comparator</code> via
- {@link JobConf#setOutputValueGroupingComparator(Class)}.Since
- {@link JobConf#setOutputKeyComparatorClass(Class)} can be used to
- control how intermediate keys are grouped, these can be used in conjunction
- to simulate <i>secondary sort on values</i>.</p>
-
-
- For example, say that you want to find duplicate web pages and tag them
- all with the url of the "best" known example. You would set up the job
- like:
- <ul>
- <li>Map Input Key: url</li>
- <li>Map Input Value: document</li>
- <li>Map Output Key: document checksum, url pagerank</li>
- <li>Map Output Value: url</li>
- <li>Partitioner: by checksum</li>
- <li>OutputKeyComparator: by checksum and then decreasing pagerank</li>
- <li>OutputValueGroupingComparator: by checksum</li>
- </ul>
- </li>
-
- <li>
- <h4 id="Reduce">Reduce</h4>
-
- <p>In this phase the
- {@link #reduce(Object, Iterator, OutputCollector, Reporter)}
- method is called for each <code><key, (list of values)></code> pair in
- the grouped inputs.</p>
- <p>The output of the reduce task is typically written to the
- {@link FileSystem} via
- {@link OutputCollector#collect(Object, Object)}.</p>
- </li>
- </ol>
-
- <p>The output of the <code>Reducer</code> is <b>not re-sorted</b>.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class MyReducer<K extends WritableComparable, V extends Writable>
- extends MapReduceBase implements Reducer<K, V, K, V> {
-
- static enum MyCounters { NUM_RECORDS }
-
- private String reduceTaskId;
- private int noKeys = 0;
-
- public void configure(JobConf job) {
- reduceTaskId = job.get("mapred.task.id");
- }
-
- public void reduce(K key, Iterator<V> values,
- OutputCollector<K, V> output,
- Reporter reporter)
- throws IOException {
-
- // Process
- int noValues = 0;
- while (values.hasNext()) {
- V value = values.next();
-
- // Increment the no. of values for this key
- ++noValues;
-
- // Process the <key, value> pair (assume this takes a while)
- // ...
- // ...
-
- // Let the framework know that we are alive, and kicking!
- if ((noValues%10) == 0) {
- reporter.progress();
- }
-
- // Process some more
- // ...
- // ...
-
- // Output the <key, value>
- output.collect(key, value);
- }
-
- // Increment the no. of <key, list of values> pairs processed
- ++noKeys;
-
- // Increment counters
- reporter.incrCounter(NUM_RECORDS, 1);
-
- // Every 100 keys update application-level status
- if ((noKeys%100) == 0) {
- reporter.setStatus(reduceTaskId + " processed " + noKeys);
- }
- }
- }
- </pre></blockquote></p>
-
- @see Mapper
- @see Partitioner
- @see Reporter
- @see MapReduceBase]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.Reducer -->
- <!-- start interface org.apache.hadoop.mapred.Reporter -->
- <interface name="Reporter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Progressable"/>
- <method name="setStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the status description for the task.
-
- @param status brief description of the current status.]]>
- </doc>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Get the {@link Counter} of the given group with the given name.
-
- @param name counter name
- @return the <code>Counter</code> of the given group/name.]]>
- </doc>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the {@link Counter} of the given group with the given name.
-
- @param group counter group
- @param name counter name
- @return the <code>Counter</code> of the given group/name.]]>
- </doc>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <param name="amount" type="long"/>
- <doc>
- <![CDATA[Increments the counter identified by the key, which can be of
- any {@link Enum} type, by the specified amount.
-
- @param key key to identify the counter to be incremented. The key can be
- be any <code>Enum</code>.
- @param amount A non-negative amount by which the counter is to
- be incremented.]]>
- </doc>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="counter" type="java.lang.String"/>
- <param name="amount" type="long"/>
- <doc>
- <![CDATA[Increments the counter identified by the group and counter name
- by the specified amount.
-
- @param group name to identify the group of the counter to be incremented.
- @param counter name to identify the counter within the group.
- @param amount A non-negative amount by which the counter is to
- be incremented.]]>
- </doc>
- </method>
- <method name="getInputSplit" return="org.apache.hadoop.mapred.InputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- <doc>
- <![CDATA[Get the {@link InputSplit} object for a map.
-
- @return the <code>InputSplit</code> that the map is reading from.
- @throws UnsupportedOperationException if called outside a mapper]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the progress of the task. Progress is represented as a number between
- 0 and 1 (inclusive).]]>
- </doc>
- </method>
- <field name="NULL" type="org.apache.hadoop.mapred.Reporter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A constant of Reporter type that does nothing.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A facility for Map-Reduce applications to report progress and update
- counters, status information etc.
-
- <p>{@link Mapper} and {@link Reducer} can use the <code>Reporter</code>
- provided to report progress or just indicate that they are alive. In
- scenarios where the application takes an insignificant amount of time to
- process individual key/value pairs, this is crucial since the framework
- might assume that the task has timed-out and kill that task.
- <p>Applications can also update {@link Counters} via the provided
- <code>Reporter</code> .</p>
-
- @see Progressable
- @see Counters]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.Reporter -->
- <!-- start interface org.apache.hadoop.mapred.RunningJob -->
- <interface name="RunningJob" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job identifier.
-
- @return the job identifier.]]>
- </doc>
- </method>
- <method name="getJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="This method is deprecated and will be removed. Applications should
- rather use {@link #getID()}.">
- <doc>
- <![CDATA[@deprecated This method is deprecated and will be removed. Applications should
- rather use {@link #getID()}.]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the job.
-
- @return the name of the job.]]>
- </doc>
- </method>
- <method name="getJobFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the path of the submitted job configuration.
-
- @return the path of the submitted job configuration.]]>
- </doc>
- </method>
- <method name="getTrackingURL" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the URL where some job progress information will be displayed.
-
- @return the URL where some job progress information will be displayed.]]>
- </doc>
- </method>
- <method name="mapProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's map-tasks, as a float between 0.0
- and 1.0. When all map tasks have completed, the function returns 1.0.
-
- @return the progress of the job's map-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="reduceProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's reduce-tasks, as a float between 0.0
- and 1.0. When all reduce tasks have completed, the function returns 1.0.
-
- @return the progress of the job's reduce-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="cleanupProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's cleanup-tasks, as a float between 0.0
- and 1.0. When all cleanup tasks have completed, the function returns 1.0.
-
- @return the progress of the job's cleanup-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="setupProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's setup-tasks, as a float between 0.0
- and 1.0. When all setup tasks have completed, the function returns 1.0.
-
- @return the progress of the job's setup-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="isComplete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if the job is finished or not.
- This is a non-blocking call.
-
- @return <code>true</code> if the job is complete, else <code>false</code>.
- @throws IOException]]>
- </doc>
- </method>
- <method name="isSuccessful" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if the job completed successfully.
-
- @return <code>true</code> if the job succeeded, else <code>false</code>.
- @throws IOException]]>
- </doc>
- </method>
- <method name="waitForCompletion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Blocks until the job is complete.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getJobState" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns the current state of the Job.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getJobStatus" return="org.apache.hadoop.mapred.JobStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns a snapshot of the current status, {@link JobStatus}, of the Job.
- Need to call again for latest information.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="killJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Kill the running job. Blocks until all job tasks have been killed as well.
- If the job is no longer running, it simply returns.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="setJobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the priority of a running job.
- @param priority the new priority for the job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startFrom" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get events indicating completion (success/failure) of component tasks.
-
- @param startFrom index to start fetching events from
- @return an array of {@link TaskCompletionEvent}s
- @throws IOException]]>
- </doc>
- </method>
- <method name="killTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="shouldFail" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Kill indicated task attempt.
-
- @param taskId the id of the task to be terminated.
- @param shouldFail if true the task is failed and added to failed tasks
- list, otherwise it is just killed, w/o affecting
- job failure status.
- @throws IOException]]>
- </doc>
- </method>
- <method name="killTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Applications should rather use {@link #killTask(TaskAttemptID, boolean)}">
- <param name="taskId" type="java.lang.String"/>
- <param name="shouldFail" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Applications should rather use {@link #killTask(TaskAttemptID, boolean)}]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the counters for this job.
-
- @return the counters for this job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getFailureInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get failure info for the job.
- @return the failure info for the job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskDiagnostics" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the diagnostic messages for a given task attempt.
- @param taskid
- @return the list of diagnostic messages for the task
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>RunningJob</code> is the user-interface to query for details on a
- running Map-Reduce job.
-
- <p>Clients can get hold of <code>RunningJob</code> via the {@link JobClient}
- and then query the running-job for details such as name, configuration,
- progress etc.</p>
-
- @see JobClient]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.RunningJob -->
- <!-- start class org.apache.hadoop.mapred.SafeModeException -->
- <class name="SafeModeException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SafeModeException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[SafeModeException
- @param adminUser admin who put JobTracker in safe-mode,
- <code>null</code> if it was automatic]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when the JobTracker is in safe mode.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SafeModeException -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat -->
- <class name="SequenceFileAsBinaryInputFormat" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsBinaryInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[InputFormat reading keys, values from SequenceFiles in binary (raw)
- format.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
- <class name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="createKey" return="org.apache.hadoop.io.BytesWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="org.apache.hadoop.io.BytesWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getKeyClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the name of the key class for this SequenceFile.
- @see org.apache.hadoop.io.SequenceFile.Reader#getKeyClassName]]>
- </doc>
- </method>
- <method name="getValueClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the name of the value class for this SequenceFile.
- @see org.apache.hadoop.io.SequenceFile.Reader#getValueClassName]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.BytesWritable"/>
- <param name="val" type="org.apache.hadoop.io.BytesWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read raw bytes from a SequenceFile.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the progress within the input split
- @return 0.0 to 1.0 of the input byte range]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Read records from a SequenceFile as binary (raw) bytes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat -->
- <class name="SequenceFileAsBinaryOutputFormat" extends="org.apache.hadoop.mapred.SequenceFileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsBinaryOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setSequenceFileOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the key class for the {@link SequenceFile}
- <p>This allows the user to specify the key class to be different
- from the actual class ({@link BytesWritable}) used for writing </p>
-
- @param conf the {@link JobConf} to modify
- @param theClass the SequenceFile output key class.]]>
- </doc>
- </method>
- <method name="setSequenceFileOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value class for the {@link SequenceFile}
- <p>This allows the user to specify the value class to be different
- from the actual class ({@link BytesWritable}) used for writing </p>
-
- @param conf the {@link JobConf} to modify
- @param theClass the SequenceFile output key class.]]>
- </doc>
- </method>
- <method name="getSequenceFileOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the key class for the {@link SequenceFile}
-
- @return the key class of the {@link SequenceFile}]]>
- </doc>
- </method>
- <method name="getSequenceFileOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the value class for the {@link SequenceFile}
-
- @return the value class of the {@link SequenceFile}]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes keys, values to
- {@link SequenceFile}s in binary(raw) format]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
- <class name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" type="org.apache.hadoop.io.BytesWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="org.apache.hadoop.io.BytesWritable"/>
- </method>
- <method name="writeUncompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Inner class used for appendRaw]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsTextInputFormat -->
- <class name="SequenceFileAsTextInputFormat" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsTextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class is similar to SequenceFileInputFormat, except it generates SequenceFileAsTextRecordReader
- which converts the input keys and values to their String forms by calling toString() method.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsTextInputFormat -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileAsTextRecordReader -->
- <class name="SequenceFileAsTextRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="SequenceFileAsTextRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="createKey" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read key/value pair in a line.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class converts the input keys and values to their String forms by calling toString()
- method. This class to SequenceFileAsTextInputFormat class is as LineRecordReader
- class to TextInputFormat class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileAsTextRecordReader -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter -->
- <class name="SequenceFileInputFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a record reader for the given split
- @param split file split
- @param job job configuration
- @param reporter reporter who sends report to task tracker
- @return RecordReader]]>
- </doc>
- </method>
- <method name="setFilterClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="filterClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[set the filter class
-
- @param conf application configuration
- @param filterClass filter class]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that allows a map/red job to work on a sample of sequence files.
- The sample is decided by the filter class set by the job.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter -->
- <!-- start interface org.apache.hadoop.mapred.SequenceFileInputFilter.Filter -->
- <interface name="SequenceFileInputFilter.Filter" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[filter function
- Decide if a record should be filtered or not
- @param key record key
- @return true if a record is accepted; return false otherwise]]>
- </doc>
- </method>
- <doc>
- <![CDATA[filter interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.SequenceFileInputFilter.Filter -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase -->
- <class name="SequenceFileInputFilter.FilterBase" extends="java.lang.Object"
- abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.SequenceFileInputFilter.Filter"/>
- <constructor name="SequenceFileInputFilter.FilterBase"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[base class for Filters]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.MD5Filter -->
- <class name="SequenceFileInputFilter.MD5Filter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.MD5Filter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setFrequency"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="frequency" type="int"/>
- <doc>
- <![CDATA[set the filtering frequency in configuration
-
- @param conf configuration
- @param frequency filtering frequency]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the filter according to configuration
-
- @param conf configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If MD5(key) % frequency==0, return true; otherwise return false
- @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
- </doc>
- </method>
- <field name="MD5_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class returns a set of records by examing the MD5 digest of its
- key against a filtering frequency <i>f</i>. The filtering criteria is
- MD5(key) % f == 0.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.MD5Filter -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.PercentFilter -->
- <class name="SequenceFileInputFilter.PercentFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.PercentFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setFrequency"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="frequency" type="int"/>
- <doc>
- <![CDATA[set the frequency and stores it in conf
- @param conf configuration
- @param frequency filtering frequencey]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the filter by checking the configuration
-
- @param conf configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If record# % frequency==0, return true; otherwise return false
- @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class returns a percentage of records
- The percentage is determined by a filtering frequency <i>f</i> using
- the criteria record# % f == 0.
- For example, if the frequency is 10, one out of 10 records is returned.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.PercentFilter -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.RegexFilter -->
- <class name="SequenceFileInputFilter.RegexFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.RegexFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setPattern"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="regex" type="java.lang.String"/>
- <exception name="PatternSyntaxException" type="java.util.regex.PatternSyntaxException"/>
- <doc>
- <![CDATA[Define the filtering regex and stores it in conf
- @param conf where the regex is set
- @param regex regex used as a filter]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the Filter by checking the configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If key matches the regex, return true; otherwise return false
- @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Records filter by matching key to regex]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.RegexFilter -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileInputFormat -->
- <class name="SequenceFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileInputFormat -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileOutputFormat -->
- <class name="SequenceFileOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getReaders" return="org.apache.hadoop.io.SequenceFile.Reader[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Open the output generated by this format.]]>
- </doc>
- </method>
- <method name="getOutputCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the {@link CompressionType} for the output {@link SequenceFile}.
- @param conf the {@link JobConf}
- @return the {@link CompressionType} for the output {@link SequenceFile},
- defaulting to {@link CompressionType#RECORD}]]>
- </doc>
- </method>
- <method name="setOutputCompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="style" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <doc>
- <![CDATA[Set the {@link CompressionType} for the output {@link SequenceFile}.
- @param conf the {@link JobConf} to modify
- @param style the {@link CompressionType} for the output
- {@link SequenceFile}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.SequenceFileRecordReader -->
- <class name="SequenceFileRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="SequenceFileRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class of key that must be passed to {@link
- #next(Object, Object)}..]]>
- </doc>
- </method>
- <method name="getValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class of value that must be passed to {@link
- #next(Object, Object)}..]]>
- </doc>
- </method>
- <method name="createKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCurrentValue"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the progress within the input split
- @return 0.0 to 1.0 of the input byte range]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="seek"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pos" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="conf" type="org.apache.hadoop.conf.Configuration"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An {@link RecordReader} for {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SequenceFileRecordReader -->
- <!-- start class org.apache.hadoop.mapred.ShuffleExceptionTracker -->
- <class name="ShuffleExceptionTracker" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getNumRequests" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the number of requests we are tracking
- @return number of requests]]>
- </doc>
- </method>
- <method name="getPercentExceptions" return="float"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the percent of the requests that had exceptions occur.
- @return percent failures as float]]>
- </doc>
- </method>
- <method name="success"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Mark the request as success.]]>
- </doc>
- </method>
- <method name="exception"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Mark the request as an exception occurred.]]>
- </doc>
- </method>
- <method name="checkException" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ie" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parse the exception to see if it matches the regular expression you
- configured. If both msgRegex and StackRegex are set then make sure both
- match, otherwise only one has to match. Abort if the limit is hit.
- @param ie - the shuffle exception that occurred
- @return true if the exception matches, false otherwise]]>
- </doc>
- </method>
- <method name="doAbort"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class is used to track shuffle exceptions. It contains routines
- to check an exception that occurred while fetching the Map output to see if it
- matches what was configured. It also provides functions to keep track of
- the number of exceptions that occurred and if a limit is set, it will
- abort the TT. The limit is a percent of exceptions of the last X number of
- requests.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.ShuffleExceptionTracker -->
- <!-- start class org.apache.hadoop.mapred.SkipBadRecords -->
- <class name="SkipBadRecords" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SkipBadRecords"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAttemptsToStartSkipping" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the number of Task attempts AFTER which skip mode
- will be kicked off. When skip mode is kicked off, the
- tasks reports the range of records which it will process
- next to the TaskTracker. So that on failures, TT knows which
- ones are possibly the bad records. On further executions,
- those are skipped.
- Default value is 2.
-
- @param conf the configuration
- @return attemptsToStartSkipping no of task attempts]]>
- </doc>
- </method>
- <method name="setAttemptsToStartSkipping"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="attemptsToStartSkipping" type="int"/>
- <doc>
- <![CDATA[Set the number of Task attempts AFTER which skip mode
- will be kicked off. When skip mode is kicked off, the
- tasks reports the range of records which it will process
- next to the TaskTracker. So that on failures, TT knows which
- ones are possibly the bad records. On further executions,
- those are skipped.
- Default value is 2.
-
- @param conf the configuration
- @param attemptsToStartSkipping no of task attempts]]>
- </doc>
- </method>
- <method name="getAutoIncrMapperProcCount" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the flag which if set to true,
- {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS} is incremented
- by MapRunner after invoking the map function. This value must be set to
- false for applications which process the records asynchronously
- or buffer the input records. For example streaming.
- In such cases applications should increment this counter on their own.
- Default value is true.
-
- @param conf the configuration
- @return <code>true</code> if auto increment
- {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS}.
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setAutoIncrMapperProcCount"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="autoIncr" type="boolean"/>
- <doc>
- <![CDATA[Set the flag which if set to true,
- {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS} is incremented
- by MapRunner after invoking the map function. This value must be set to
- false for applications which process the records asynchronously
- or buffer the input records. For example streaming.
- In such cases applications should increment this counter on their own.
- Default value is true.
-
- @param conf the configuration
- @param autoIncr whether to auto increment
- {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS}.]]>
- </doc>
- </method>
- <method name="getAutoIncrReducerProcCount" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the flag which if set to true,
- {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS} is incremented
- by framework after invoking the reduce function. This value must be set to
- false for applications which process the records asynchronously
- or buffer the input records. For example streaming.
- In such cases applications should increment this counter on their own.
- Default value is true.
-
- @param conf the configuration
- @return <code>true</code> if auto increment
- {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS}.
- <code>false</code> otherwise.]]>
- </doc>
- </method>
- <method name="setAutoIncrReducerProcCount"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="autoIncr" type="boolean"/>
- <doc>
- <![CDATA[Set the flag which if set to true,
- {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS} is incremented
- by framework after invoking the reduce function. This value must be set to
- false for applications which process the records asynchronously
- or buffer the input records. For example streaming.
- In such cases applications should increment this counter on their own.
- Default value is true.
-
- @param conf the configuration
- @param autoIncr whether to auto increment
- {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS}.]]>
- </doc>
- </method>
- <method name="getSkipOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the directory to which skipped records are written. By default it is
- the sub directory of the output _logs directory.
- User can stop writing skipped records by setting the value null.
-
- @param conf the configuration.
- @return path skip output directory. Null is returned if this is not set
- and output directory is also not set.]]>
- </doc>
- </method>
- <method name="setSkipOutputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the directory to which skipped records are written. By default it is
- the sub directory of the output _logs directory.
- User can stop writing skipped records by setting the value null.
-
- @param conf the configuration.
- @param path skip output directory path]]>
- </doc>
- </method>
- <method name="getMapperMaxSkipRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the number of acceptable skip records surrounding the bad record PER
- bad record in mapper. The number includes the bad record as well.
- To turn the feature of detection/skipping of bad records off, set the
- value to 0.
- The framework tries to narrow down the skipped range by retrying
- until this threshold is met OR all attempts get exhausted for this task.
- Set the value to Long.MAX_VALUE to indicate that framework need not try to
- narrow down. Whatever records(depends on application) get skipped are
- acceptable.
- Default value is 0.
-
- @param conf the configuration
- @return maxSkipRecs acceptable skip records.]]>
- </doc>
- </method>
- <method name="setMapperMaxSkipRecords"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="maxSkipRecs" type="long"/>
- <doc>
- <![CDATA[Set the number of acceptable skip records surrounding the bad record PER
- bad record in mapper. The number includes the bad record as well.
- To turn the feature of detection/skipping of bad records off, set the
- value to 0.
- The framework tries to narrow down the skipped range by retrying
- until this threshold is met OR all attempts get exhausted for this task.
- Set the value to Long.MAX_VALUE to indicate that framework need not try to
- narrow down. Whatever records(depends on application) get skipped are
- acceptable.
- Default value is 0.
-
- @param conf the configuration
- @param maxSkipRecs acceptable skip records.]]>
- </doc>
- </method>
- <method name="getReducerMaxSkipGroups" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the number of acceptable skip groups surrounding the bad group PER
- bad group in reducer. The number includes the bad group as well.
- To turn the feature of detection/skipping of bad groups off, set the
- value to 0.
- The framework tries to narrow down the skipped range by retrying
- until this threshold is met OR all attempts get exhausted for this task.
- Set the value to Long.MAX_VALUE to indicate that framework need not try to
- narrow down. Whatever groups(depends on application) get skipped are
- acceptable.
- Default value is 0.
-
- @param conf the configuration
- @return maxSkipGrps acceptable skip groups.]]>
- </doc>
- </method>
- <method name="setReducerMaxSkipGroups"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="maxSkipGrps" type="long"/>
- <doc>
- <![CDATA[Set the number of acceptable skip groups surrounding the bad group PER
- bad group in reducer. The number includes the bad group as well.
- To turn the feature of detection/skipping of bad groups off, set the
- value to 0.
- The framework tries to narrow down the skipped range by retrying
- until this threshold is met OR all attempts get exhausted for this task.
- Set the value to Long.MAX_VALUE to indicate that framework need not try to
- narrow down. Whatever groups(depends on application) get skipped are
- acceptable.
- Default value is 0.
-
- @param conf the configuration
- @param maxSkipGrps acceptable skip groups.]]>
- </doc>
- </method>
- <field name="COUNTER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Special counters which are written by the application and are
- used by the framework for detecting bad records. For detecting bad records
- these counters must be incremented by the application.]]>
- </doc>
- </field>
- <field name="COUNTER_MAP_PROCESSED_RECORDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of processed map records.
- @see SkipBadRecords#getAutoIncrMapperProcCount(Configuration)]]>
- </doc>
- </field>
- <field name="COUNTER_REDUCE_PROCESSED_GROUPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of processed reduce groups.
- @see SkipBadRecords#getAutoIncrReducerProcCount(Configuration)]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Utility class for skip bad records functionality. It contains various
- settings related to skipping of bad records.
-
- <p>Hadoop provides an optional mode of execution in which the bad records
- are detected and skipped in further attempts.
-
- <p>This feature can be used when map/reduce tasks crashes deterministically on
- certain input. This happens due to bugs in the map/reduce function. The usual
- course would be to fix these bugs. But sometimes this is not possible;
- perhaps the bug is in third party libraries for which the source code is
- not available. Due to this, the task never reaches to completion even with
- multiple attempts and complete data for that task is lost.</p>
-
- <p>With this feature, only a small portion of data is lost surrounding
- the bad record, which may be acceptable for some user applications.
- see {@link SkipBadRecords#setMapperMaxSkipRecords(Configuration, long)}</p>
-
- <p>The skipping mode gets kicked off after certain no of failures
- see {@link SkipBadRecords#setAttemptsToStartSkipping(Configuration, int)}</p>
-
- <p>In the skipping mode, the map/reduce task maintains the record range which
- is getting processed at all times. Before giving the input to the
- map/reduce function, it sends this record range to the Task tracker.
- If task crashes, the Task tracker knows which one was the last reported
- range. On further attempts that range get skipped.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.SkipBadRecords -->
- <!-- start class org.apache.hadoop.mapred.Task -->
- <class name="Task" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="Task"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Task" type="java.lang.String, org.apache.hadoop.mapred.TaskAttemptID, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getFileSystemCounterNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="uriScheme" type="java.lang.String"/>
- <doc>
- <![CDATA[Counters to measure the usage of the different file systems.
- Always return the String array with two elements. First one is the name of
- BYTES_READ counter and second one is of the BYTES_WRITTEN counter.]]>
- </doc>
- </method>
- <method name="setJobFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobFile" type="java.lang.String"/>
- </method>
- <method name="getJobFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskID" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumSlotsRequired" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job name for this task.
- @return the job name]]>
- </doc>
- </method>
- <method name="setJobTokenSecret"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokenSecret" type="javax.crypto.SecretKey"/>
- <doc>
- <![CDATA[Set the job token secret
- @param tokenSecret the secret]]>
- </doc>
- </method>
- <method name="getJobTokenSecret" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job token secret
- @return the token secret]]>
- </doc>
- </method>
- <method name="setJvmContext"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <doc>
- <![CDATA[Set the task JvmContext
- @param jvmContext]]>
- </doc>
- </method>
- <method name="getJvmContext" return="org.apache.hadoop.mapred.JvmContext"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Gets the task JvmContext
- @return the jvm context]]>
- </doc>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the index of this task within the job.
- @return the integer part of the task id]]>
- </doc>
- </method>
- <method name="getPhase" return="org.apache.hadoop.mapred.TaskStatus.Phase"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return current phase of the task.
- needs to be synchronized as communication thread sends the phase every second
- @return the curent phase of the task]]>
- </doc>
- </method>
- <method name="setPhase"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="phase" type="org.apache.hadoop.mapred.TaskStatus.Phase"/>
- <doc>
- <![CDATA[Set current phase of the task.
- @param phase task phase]]>
- </doc>
- </method>
- <method name="toWriteSkipRecs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether to write skip records.]]>
- </doc>
- </method>
- <method name="setWriteSkipRecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="writeSkipRecs" type="boolean"/>
- <doc>
- <![CDATA[Set whether to write skip records.]]>
- </doc>
- </method>
- <method name="reportFatalError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="throwable" type="java.lang.Throwable"/>
- <param name="logMsg" type="java.lang.String"/>
- <doc>
- <![CDATA[Report a fatal error to the parent (task) tracker.]]>
- </doc>
- </method>
- <method name="getSkipRanges" return="org.apache.hadoop.mapred.SortedRanges"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get skipRanges.]]>
- </doc>
- </method>
- <method name="setSkipRanges"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="skipRanges" type="org.apache.hadoop.mapred.SortedRanges"/>
- <doc>
- <![CDATA[Set skipRanges.]]>
- </doc>
- </method>
- <method name="isSkipping" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is Task in skipping mode.]]>
- </doc>
- </method>
- <method name="setSkipping"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="skipping" type="boolean"/>
- <doc>
- <![CDATA[Sets whether to run Task in skipping mode.
- @param skipping]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the user running the job/task. TaskTracker needs task's
- user name even before it's JobConf is localized. So we explicitly serialize
- the user name.
-
- @return user]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="localizeConfiguration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Localize the given JobConf to be specific for this task.]]>
- </doc>
- </method>
- <method name="run"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Run this task as a part of the named job. This method is executed in the
- child process and is what invokes user-supplied map, reduce, etc. methods.
- @param umbilical for progress reports]]>
- </doc>
- </method>
- <method name="createRunner" return="org.apache.hadoop.mapred.TaskRunner"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tracker" type="org.apache.hadoop.mapred.TaskTracker"/>
- <param name="tip" type="org.apache.hadoop.mapred.TaskTracker.TaskInProgress"/>
- <param name="rjob" type="org.apache.hadoop.mapred.TaskTracker.RunningJob"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return an approprate thread runner for this task.
- @param tip TODO]]>
- </doc>
- </method>
- <method name="isMapTask" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="org.apache.hadoop.util.Progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="id" type="org.apache.hadoop.mapred.JobID"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <param name="useNewApi" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="reportNextRecordRange"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="nextRecIndex" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Reports the next executing record range to TaskTracker.
-
- @param umbilical
- @param nextRecIndex the record index which would be fed next.
- @throws IOException]]>
- </doc>
- </method>
- <method name="done"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Task.TaskReporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="statusUpdate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="runTaskCleanupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Task.TaskReporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="runJobCleanupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Task.TaskReporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="supportIsolationRunner" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="runJobSetupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Task.TaskReporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getFsStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets a handle to the Statistics instance based on the scheme associated
- with path.
-
- @param path
- the path.
- @return a Statistics instance, or null if none is found for the scheme.]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createReduceContext" return="org.apache.hadoop.mapreduce.Reducer.Context"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="reducer" type="org.apache.hadoop.mapreduce.Reducer"/>
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <param name="taskId" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
- <param name="rIter" type="org.apache.hadoop.mapred.RawKeyValueIterator"/>
- <param name="inputKeyCounter" type="org.apache.hadoop.mapreduce.Counter"/>
- <param name="inputValueCounter" type="org.apache.hadoop.mapreduce.Counter"/>
- <param name="output" type="org.apache.hadoop.mapreduce.RecordWriter"/>
- <param name="committer" type="org.apache.hadoop.mapreduce.OutputCommitter"/>
- <param name="reporter" type="org.apache.hadoop.mapreduce.StatusReporter"/>
- <param name="comparator" type="org.apache.hadoop.io.RawComparator"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- </method>
- <field name="MR_COMBINE_RECORDS_BEFORE_PROGRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_MR_COMBINE_RECORDS_BEFORE_PROGRESS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILESYSTEM_COUNTER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Name of the FileSystem counters' group]]>
- </doc>
- </field>
- <field name="jobRunStateForCleanup" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="jobCleanup" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="jobSetup" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="taskCleanup" type="boolean"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="conf" type="org.apache.hadoop.mapred.JobConf"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="mapOutputFile" type="org.apache.hadoop.mapred.MapOutputFile"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="lDirAlloc" type="org.apache.hadoop.fs.LocalDirAllocator"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="jobContext" type="org.apache.hadoop.mapred.JobContext"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="outputFormat" type="org.apache.hadoop.mapreduce.OutputFormat"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="committer" type="org.apache.hadoop.mapreduce.OutputCommitter"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="spilledRecordsCounter" type="org.apache.hadoop.mapred.Counters.Counter"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="umbilical" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="tokenSecret" type="javax.crypto.SecretKey"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="PROGRESS_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of milliseconds between progress reports.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Base class for tasks.
-
- This is NOT a public interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task -->
- <!-- start class org.apache.hadoop.mapred.Task.CombineOutputCollector -->
- <class name="Task.CombineOutputCollector" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.OutputCollector"/>
- <constructor name="Task.CombineOutputCollector" type="org.apache.hadoop.mapred.Counters.Counter, org.apache.hadoop.util.Progressable, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setWriter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writer" type="org.apache.hadoop.mapred.IFile.Writer"/>
- </method>
- <method name="collect"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[OutputCollector for the combiner.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.CombineOutputCollector -->
- <!-- start class org.apache.hadoop.mapred.Task.CombinerRunner -->
- <class name="Task.CombinerRunner" extends="java.lang.Object"
- abstract="true"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <field name="inputCounter" type="org.apache.hadoop.mapred.Counters.Counter"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="job" type="org.apache.hadoop.mapred.JobConf"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="reporter" type="org.apache.hadoop.mapred.Task.TaskReporter"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.CombinerRunner -->
- <!-- start class org.apache.hadoop.mapred.Task.CombineValuesIterator -->
- <class name="Task.CombineValuesIterator" extends="org.apache.hadoop.mapred.Task.ValuesIterator"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="Task.CombineValuesIterator" type="org.apache.hadoop.mapred.RawKeyValueIterator, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.Reporter, org.apache.hadoop.mapred.Counters.Counter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="next" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.CombineValuesIterator -->
- <!-- start class org.apache.hadoop.mapred.Task.Counter -->
- <class name="Task.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.Task.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.Task.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="MAP_INPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_OUTPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_SKIPPED_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_INPUT_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_OUTPUT_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_OUTPUT_MATERIALIZED_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMBINE_INPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMBINE_OUTPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_INPUT_GROUPS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_SHUFFLE_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_INPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_OUTPUT_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_SKIPPED_GROUPS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_SKIPPED_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SPILLED_RECORDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SPLIT_RAW_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CPU_MILLISECONDS" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PHYSICAL_MEMORY_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VIRTUAL_MEMORY_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMITTED_HEAP_BYTES" type="org.apache.hadoop.mapred.Task.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.Counter -->
- <!-- start class org.apache.hadoop.mapred.Task.NewCombinerRunner -->
- <class name="Task.NewCombinerRunner" extends="org.apache.hadoop.mapred.Task.CombinerRunner"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.NewCombinerRunner -->
- <!-- start class org.apache.hadoop.mapred.Task.OldCombinerRunner -->
- <class name="Task.OldCombinerRunner" extends="org.apache.hadoop.mapred.Task.CombinerRunner"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="Task.OldCombinerRunner" type="java.lang.Class, org.apache.hadoop.mapred.JobConf, org.apache.hadoop.mapred.Counters.Counter, org.apache.hadoop.mapred.Task.TaskReporter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="combine"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="kvIter" type="org.apache.hadoop.mapred.RawKeyValueIterator"/>
- <param name="combineCollector" type="org.apache.hadoop.mapred.OutputCollector"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.OldCombinerRunner -->
- <!-- start class org.apache.hadoop.mapred.Task.TaskReporter -->
- <class name="Task.TaskReporter" extends="org.apache.hadoop.mapreduce.StatusReporter"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="java.lang.Runnable"/>
- <implements name="org.apache.hadoop.mapred.Reporter"/>
- <method name="setStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- </method>
- <method name="setProgress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.Enum"/>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <param name="amount" type="long"/>
- </method>
- <method name="incrCounter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="counter" type="java.lang.String"/>
- <param name="amount" type="long"/>
- </method>
- <method name="setInputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- </method>
- <method name="getInputSplit" return="org.apache.hadoop.mapred.InputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The communication thread handles communication with the parent (Task Tracker).
- It sends progress updates if progress has been made or if the task needs to
- let the parent know that it's alive. It also pings the parent to see if it's alive.]]>
- </doc>
- </method>
- <method name="startCommunicationThread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="stopCommunicationThread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.Task.TaskReporter -->
- <!-- start class org.apache.hadoop.mapred.TaskAttemptContext -->
- <class name="TaskAttemptContext" extends="org.apache.hadoop.mapreduce.TaskAttemptContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getTaskAttemptID" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the taskAttemptID.
-
- @return TaskAttemptID]]>
- </doc>
- </method>
- <method name="getProgressible" return="org.apache.hadoop.util.Progressable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskAttemptContext -->
- <!-- start class org.apache.hadoop.mapred.TaskAttemptID -->
- <class name="TaskAttemptID" extends="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskAttemptID" type="org.apache.hadoop.mapred.TaskID, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskAttemptID object from given {@link TaskID}.
- @param taskId TaskID that this task belongs to
- @param id the task attempt number]]>
- </doc>
- </constructor>
- <constructor name="TaskAttemptID" type="java.lang.String, int, boolean, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskId object from given parts.
- @param jtIdentifier jobTracker identifier
- @param jobId job number
- @param isMap whether the tip is a map
- @param taskId taskId number
- @param id the task attempt number]]>
- </doc>
- </constructor>
- <constructor name="TaskAttemptID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="downgrade" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="old" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
- <doc>
- <![CDATA[Downgrade a new TaskAttemptID to an old one
- @param old the new id
- @return either old or a new TaskAttemptID constructed to match old]]>
- </doc>
- </method>
- <method name="getTaskID" return="org.apache.hadoop.mapred.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="read" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="forName" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a TaskAttemptID object from given string
- @return constructed TaskAttemptID object or null if the given String is null
- @throws IllegalArgumentException if the given string is malformed]]>
- </doc>
- </method>
- <method name="getTaskAttemptIDsPattern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jtIdentifier" type="java.lang.String"/>
- <param name="jobId" type="java.lang.Integer"/>
- <param name="isMap" type="java.lang.Boolean"/>
- <param name="taskId" type="java.lang.Integer"/>
- <param name="attemptId" type="java.lang.Integer"/>
- <doc>
- <![CDATA[Returns a regex pattern which matches task attempt IDs. Arguments can
- be given null, in which case that part of the regex will be generic.
- For example to obtain a regex matching <i>all task attempt IDs</i>
- of <i>any jobtracker</i>, in <i>any job</i>, of the <i>first
- map task</i>, we would use :
- <pre>
- TaskAttemptID.getTaskAttemptIDsPattern(null, null, true, 1, null);
- </pre>
- which will return :
- <pre> "attempt_[^_]*_[0-9]*_m_000001_[0-9]*" </pre>
- @param jtIdentifier jobTracker identifier, or null
- @param jobId job number, or null
- @param isMap whether the tip is a map, or null
- @param taskId taskId number, or null
- @param attemptId the task attempt number, or null
- @return a regex pattern matching TaskAttemptIDs]]>
- </doc>
- </method>
- <doc>
- <![CDATA[TaskAttemptID represents the immutable and unique identifier for
- a task attempt. Each task attempt is one particular instance of a Map or
- Reduce Task identified by its TaskID.
-
- TaskAttemptID consists of 2 parts. First part is the
- {@link TaskID}, that this TaskAttemptID belongs to.
- Second part is the task attempt number. <br>
- An example TaskAttemptID is :
- <code>attempt_200707121733_0003_m_000005_0</code> , which represents the
- zeroth task attempt for the fifth map task in the third job
- running at the jobtracker started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse TaskAttemptID strings
- , but rather use appropriate constructors or {@link #forName(String)}
- method.
-
- @see JobID
- @see TaskID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskAttemptID -->
- <!-- start class org.apache.hadoop.mapred.TaskCompletionEvent -->
- <class name="TaskCompletionEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TaskCompletionEvent"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor for Writable.]]>
- </doc>
- </constructor>
- <constructor name="TaskCompletionEvent" type="int, org.apache.hadoop.mapred.TaskAttemptID, int, boolean, org.apache.hadoop.mapred.TaskCompletionEvent.Status, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor. eventId should be created externally and incremented
- per event for each job.
- @param eventId event id, event id should be unique and assigned in
- incrementally, starting from 0.
- @param taskId task id
- @param status task's status
- @param taskTrackerHttp task tracker's host:port for http.]]>
- </doc>
- </constructor>
- <method name="getEventId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns event Id.
- @return event id]]>
- </doc>
- </method>
- <method name="getTaskId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getTaskAttemptId()} instead.">
- <doc>
- <![CDATA[Returns task id.
- @return task id
- @deprecated use {@link #getTaskAttemptId()} instead.]]>
- </doc>
- </method>
- <method name="getTaskAttemptId" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns task id.
- @return task id]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns enum Status.SUCESS or Status.FAILURE.
- @return task tracker status]]>
- </doc>
- </method>
- <method name="getTaskTrackerHttp" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[http location of the tasktracker where this task ran.
- @return http location of tasktracker user logs]]>
- </doc>
- </method>
- <method name="getTaskRunTime" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns time (in millisec) the task took to complete.]]>
- </doc>
- </method>
- <method name="setTaskRunTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskCompletionTime" type="int"/>
- <doc>
- <![CDATA[Set the task completion time
- @param taskCompletionTime time (in millisec) the task took to complete]]>
- </doc>
- </method>
- <method name="setEventId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventId" type="int"/>
- <doc>
- <![CDATA[set event Id. should be assigned incrementally starting from 0.
- @param eventId]]>
- </doc>
- </method>
- <method name="setTaskId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #setTaskID(TaskAttemptID)} instead.">
- <param name="taskId" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets task id.
- @param taskId
- @deprecated use {@link #setTaskID(TaskAttemptID)} instead.]]>
- </doc>
- </method>
- <method name="setTaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <doc>
- <![CDATA[Sets task id.
- @param taskId]]>
- </doc>
- </method>
- <method name="setTaskStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"/>
- <doc>
- <![CDATA[Set task status.
- @param status]]>
- </doc>
- </method>
- <method name="setTaskTrackerHttp"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskTrackerHttp" type="java.lang.String"/>
- <doc>
- <![CDATA[Set task tracker http location.
- @param taskTrackerHttp]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isMapTask" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="idWithinJob" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="EMPTY_ARRAY" type="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This is used to track task completion events on
- job tracker.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskCompletionEvent -->
- <!-- start class org.apache.hadoop.mapred.TaskCompletionEvent.Status -->
- <class name="TaskCompletionEvent.Status" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="FAILED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUCCEEDED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OBSOLETE" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIPFAILED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskCompletionEvent.Status -->
- <!-- start class org.apache.hadoop.mapred.TaskController -->
- <class name="TaskController" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="TaskController"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLocalDirs" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="setup"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocator" type="org.apache.hadoop.fs.LocalDirAllocator"/>
- <param name="localStorage" type="org.apache.hadoop.mapred.TaskTracker.LocalStorage"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Does initialization and setup.
- @param allocator the local dir allocator to use
- @param localStorage local storage to obtain dirs from]]>
- </doc>
- </method>
- <method name="initializeJob"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- <param name="credentials" type="org.apache.hadoop.fs.Path"/>
- <param name="jobConf" type="org.apache.hadoop.fs.Path"/>
- <param name="taskTracker" type="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <param name="ttAddr" type="java.net.InetSocketAddress"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Create all of the directories necessary for the job to start and download
- all of the job and private distributed cache files.
- Creates both the user directories and the job log directory.
- @param user the user name
- @param jobid the job
- @param credentials a filename containing the job secrets
- @param jobConf the path to the localized configuration file
- @param taskTracker the connection the task tracker
- @param ttAddr the tasktracker's RPC address
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="launchTask" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobId" type="java.lang.String"/>
- <param name="attemptId" type="java.lang.String"/>
- <param name="setup" type="java.util.List"/>
- <param name="jvmArguments" type="java.util.List"/>
- <param name="currentWorkDirectory" type="java.io.File"/>
- <param name="stdout" type="java.lang.String"/>
- <param name="stderr" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create all of the directories for the task and launches the child jvm.
- @param user the user name
- @param jobId the jobId in question
- @param attemptId the attempt id (cleanup attempts have .cleanup suffix)
- @param setup list of shell commands to execute before the jvm
- @param jvmArguments list of jvm arguments
- @param currentWorkDirectory the full path of the cwd for the task
- @param stdout the file to redirect stdout to
- @param stderr the file to redirect stderr to
- @return the exit code for the task
- @throws IOException]]>
- </doc>
- </method>
- <method name="signalTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="taskPid" type="int"/>
- <param name="signal" type="org.apache.hadoop.util.ProcessTree.Signal"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Send a signal to a task pid as the user.
- @param user the user name
- @param taskPid the pid of the task
- @param signal the id of the signal to send]]>
- </doc>
- </method>
- <method name="deleteAsUser"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="subDir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the user's files under all of the task tracker root directories.
- @param user the user name
- @param subDir the path relative to the user's subdirectory under
- the task tracker root directories.
- @throws IOException]]>
- </doc>
- </method>
- <method name="createLogDir"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskID" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="isCleanup" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates task log dir
- @param taskID ID of the task
- @param isCleanup If the task is cleanup task or not
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteLogAsUser"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="subDir" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the user's files under the userlogs directory.
- @param user the user to work as
- @param subDir the path under the userlogs directory.
- @throws IOException]]>
- </doc>
- </method>
- <method name="truncateLogsAsUser"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="allAttempts" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Run the passed command as the user
- @param user
- @param allAttempts the list of attempts that the JVM ran
- @throws IOException]]>
- </doc>
- </method>
- <method name="getRunAsUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Returns the local unix user that a given job will run as.]]>
- </doc>
- </method>
- <method name="writeCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="cmdLine" type="java.lang.String"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="commandFile" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="logOutput"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="output" type="java.lang.String"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMAND_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="allocator" type="org.apache.hadoop.fs.LocalDirAllocator"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="localStorage" type="org.apache.hadoop.mapred.TaskTracker.LocalStorage"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="TASK_LAUNCH_SCRIPT_PERMISSION" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Controls initialization, finalization and clean up of tasks, and
- also the launching and killing of task JVMs.
-
- This class defines the API for initializing, finalizing and cleaning
- up of tasks, as also the launching and killing task JVMs.
- Subclasses of this class will implement the logic required for
- performing the actual actions.
-
- <br/>
-
- NOTE: This class is internal only class and not intended for users!!]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskController -->
- <!-- start class org.apache.hadoop.mapred.TaskGraphServlet -->
- <class name="TaskGraphServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskGraphServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="width" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[height of the graph w/o margins]]>
- </doc>
- </field>
- <field name="height" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[height of the graph w/o margins]]>
- </doc>
- </field>
- <field name="ymargin" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[margin space on y axis]]>
- </doc>
- </field>
- <field name="xmargin" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[margin space on x axis]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The servlet that outputs svg graphics for map / reduce task
- statuses]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskGraphServlet -->
- <!-- start class org.apache.hadoop.mapred.TaskID -->
- <class name="TaskID" extends="org.apache.hadoop.mapreduce.TaskID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskID" type="org.apache.hadoop.mapreduce.JobID, boolean, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskID object from given {@link JobID}.
- @param jobId JobID that this tip belongs to
- @param isMap whether the tip is a map
- @param id the tip number]]>
- </doc>
- </constructor>
- <constructor name="TaskID" type="java.lang.String, int, boolean, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskInProgressId object from given parts.
- @param jtIdentifier jobTracker identifier
- @param jobId job number
- @param isMap whether the tip is a map
- @param id the tip number]]>
- </doc>
- </constructor>
- <constructor name="TaskID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="downgrade" return="org.apache.hadoop.mapred.TaskID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="old" type="org.apache.hadoop.mapreduce.TaskID"/>
- <doc>
- <![CDATA[Downgrade a new TaskID to an old one
- @param old a new or old TaskID
- @return either old or a new TaskID build to match old]]>
- </doc>
- </method>
- <method name="read" return="org.apache.hadoop.mapred.TaskID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskIDsPattern" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jtIdentifier" type="java.lang.String"/>
- <param name="jobId" type="java.lang.Integer"/>
- <param name="isMap" type="java.lang.Boolean"/>
- <param name="taskId" type="java.lang.Integer"/>
- <doc>
- <![CDATA[Returns a regex pattern which matches task IDs. Arguments can
- be given null, in which case that part of the regex will be generic.
- For example to obtain a regex matching <i>the first map task</i>
- of <i>any jobtracker</i>, of <i>any job</i>, we would use :
- <pre>
- TaskID.getTaskIDsPattern(null, null, true, 1);
- </pre>
- which will return :
- <pre> "task_[^_]*_[0-9]*_m_000001*" </pre>
- @param jtIdentifier jobTracker identifier, or null
- @param jobId job number, or null
- @param isMap whether the tip is a map, or null
- @param taskId taskId number, or null
- @return a regex pattern matching TaskIDs]]>
- </doc>
- </method>
- <method name="forName" return="org.apache.hadoop.mapred.TaskID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- </method>
- <doc>
- <![CDATA[TaskID represents the immutable and unique identifier for
- a Map or Reduce Task. Each TaskID encompasses multiple attempts made to
- execute the Map or Reduce Task, each of which are uniquely indentified by
- their TaskAttemptID.
-
- TaskID consists of 3 parts. First part is the {@link JobID}, that this
- TaskInProgress belongs to. Second part of the TaskID is either 'm' or 'r'
- representing whether the task is a map task or a reduce task.
- And the third part is the task number. <br>
- An example TaskID is :
- <code>task_200707121733_0003_m_000005</code> , which represents the
- fifth map task in the third job running at the jobtracker
- started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse TaskID strings
- , but rather use appropriate constructors or {@link #forName(String)}
- method.
-
- @see JobID
- @see TaskAttemptID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskID -->
- <!-- start class org.apache.hadoop.mapred.TaskLog -->
- <class name="TaskLog" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskLog"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createTaskAttemptLogDir"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskID" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="isCleanup" type="boolean"/>
- <param name="localDirs" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create log directory for the given attempt. This involves creating the
- following and setting proper permissions for the new directories
- <br>{hadoop.log.dir}/userlogs/<jobid>
- <br>{hadoop.log.dir}/userlogs/<jobid>/<attempt-id-as-symlink>
- <br>{one of the mapred-local-dirs}/userlogs/<jobid>
- <br>{one of the mapred-local-dirs}/userlogs/<jobid>/<attempt-id>
- @param taskID attempt-id for which log dir is to be created
- @param isCleanup Is this attempt a cleanup attempt ?
- @param localDirs mapred local directories
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskAttemptLogDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskID" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="cleanupSuffix" type="java.lang.String"/>
- <param name="localDirs" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get attempt log directory path for the given attempt-id under randomly
- selected mapred local directory.
- @param taskID attempt-id for which log dir path is needed
- @param cleanupSuffix ".cleanup" if this attempt is a cleanup attempt
- @param localDirs mapred local directories
- @return target task attempt log directory
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskLogFile" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="isCleanup" type="boolean"/>
- <param name="filter" type="org.apache.hadoop.mapred.TaskLog.LogName"/>
- </method>
- <method name="getBaseLogDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="syncLogs"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logLocation" type="java.lang.String"/>
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="isCleanup" type="boolean"/>
- <param name="segmented" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getTaskLogLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the desired maximum length of task's logs.
- @param conf the job to look in
- @return the number of bytes to cap the log files at]]>
- </doc>
- </method>
- <method name="captureOutAndError" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.util.List"/>
- <param name="stdoutFilename" type="java.io.File"/>
- <param name="stderrFilename" type="java.io.File"/>
- <param name="tailLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
- If the tailLength is 0, the entire output will be saved.
- @param cmd The command and the arguments that should be run
- @param stdoutFilename The filename that stdout should be saved to
- @param stderrFilename The filename that stderr should be saved to
- @param tailLength The length of the tail to be saved.
- @return the modified command that should be run]]>
- </doc>
- </method>
- <method name="captureOutAndError" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="setup" type="java.util.List"/>
- <param name="cmd" type="java.util.List"/>
- <param name="stdoutFilename" type="java.io.File"/>
- <param name="stderrFilename" type="java.io.File"/>
- <param name="tailLength" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
- Setup commands such as setting memory limit can be passed which
- will be executed before exec.
- If the tailLength is 0, the entire output will be saved.
- @param setup The setup commands for the execed process.
- @param cmd The command and the arguments that should be run
- @param stdoutFilename The filename that stdout should be saved to
- @param stderrFilename The filename that stderr should be saved to
- @param tailLength The length of the tail to be saved.
- @return the modified command that should be run]]>
- </doc>
- </method>
- <method name="captureOutAndError" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="pidFiles are no more used. Instead pid is exported to
- env variable JVM_PID.">
- <param name="setup" type="java.util.List"/>
- <param name="cmd" type="java.util.List"/>
- <param name="stdoutFilename" type="java.io.File"/>
- <param name="stderrFilename" type="java.io.File"/>
- <param name="tailLength" type="long"/>
- <param name="pidFileName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
- Setup commands such as setting memory limit can be passed which
- will be executed before exec.
- If the tailLength is 0, the entire output will be saved.
- @param setup The setup commands for the execed process.
- @param cmd The command and the arguments that should be run
- @param stdoutFilename The filename that stdout should be saved to
- @param stderrFilename The filename that stderr should be saved to
- @param tailLength The length of the tail to be saved.
- @deprecated pidFiles are no more used. Instead pid is exported to
- env variable JVM_PID.
- @return the modified command that should be run]]>
- </doc>
- </method>
- <method name="captureOutAndError" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="pidFiles are no more used. Instead pid is exported to
- env variable JVM_PID.">
- <param name="setup" type="java.util.List"/>
- <param name="cmd" type="java.util.List"/>
- <param name="stdoutFilename" type="java.io.File"/>
- <param name="stderrFilename" type="java.io.File"/>
- <param name="tailLength" type="long"/>
- <param name="useSetsid" type="boolean"/>
- <param name="pidFileName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
- Setup commands such as setting memory limit can be passed which
- will be executed before exec.
- If the tailLength is 0, the entire output will be saved.
- @param setup The setup commands for the execed process.
- @param cmd The command and the arguments that should be run
- @param stdoutFilename The filename that stdout should be saved to
- @param stderrFilename The filename that stderr should be saved to
- @param tailLength The length of the tail to be saved.
- @param useSetsid Should setsid be used in the command or not.
- @deprecated pidFiles are no more used. Instead pid is exported to
- env variable JVM_PID.
- @return the modified command that should be run]]>
- </doc>
- </method>
- <method name="captureOutAndError" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="setup" type="java.util.List"/>
- <param name="cmd" type="java.util.List"/>
- <param name="stdoutFilename" type="java.io.File"/>
- <param name="stderrFilename" type="java.io.File"/>
- <param name="tailLength" type="long"/>
- <param name="useSetsid" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
- Setup commands such as setting memory limit can be passed which
- will be executed before exec.
- If the tailLength is 0, the entire output will be saved.
- @param setup The setup commands for the execed process.
- @param cmd The command and the arguments that should be run
- @param stdoutFilename The filename that stdout should be saved to
- @param stderrFilename The filename that stderr should be saved to
- @param tailLength The length of the tail to be saved.
- @param useSetsid Should setsid be used in the command or not.
- @return the modified command that should be run]]>
- </doc>
- </method>
- <method name="addCommand" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.util.List"/>
- <param name="isExecutable" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add quotes to each of the command strings and
- return as a single string
- @param cmd The command to be quoted
- @param isExecutable makes shell path if the first
- argument is executable
- @return returns The quoted string.
- @throws IOException]]>
- </doc>
- </method>
- <method name="captureDebugOut" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cmd" type="java.util.List"/>
- <param name="debugoutFilename" type="java.io.File"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Wrap a command in a shell to capture debug script's
- stdout and stderr to debugout.
- @param cmd The command and the arguments that should be run
- @param debugoutFilename The filename that stdout and stderr
- should be saved to.
- @return the modified command that should be run
- @throws IOException]]>
- </doc>
- </method>
- <method name="getUserLogDir" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobDir" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the user log directory for the job jobid.
-
- @param jobid string representation of the jobid
- @return user log directory for the job]]>
- </doc>
- </method>
- <method name="getJobDir" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <doc>
- <![CDATA[Get the user log directory for the job jobid.
-
- @param jobid the jobid object
- @return user log directory for the job]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A simple logger to handle the task-specific user logs.
- This class uses the system property <code>hadoop.log.dir</code>.
-
- This class is for Map/Reduce internal use only.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskLog -->
- <!-- start class org.apache.hadoop.mapred.TaskLog.LogName -->
- <class name="TaskLog.LogName" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.TaskLog.LogName[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.TaskLog.LogName"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="STDOUT" type="org.apache.hadoop.mapred.TaskLog.LogName"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log on the stdout of the task.]]>
- </doc>
- </field>
- <field name="STDERR" type="org.apache.hadoop.mapred.TaskLog.LogName"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log on the stderr of the task.]]>
- </doc>
- </field>
- <field name="SYSLOG" type="org.apache.hadoop.mapred.TaskLog.LogName"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log on the map-reduce system logs of the task.]]>
- </doc>
- </field>
- <field name="PROFILE" type="org.apache.hadoop.mapred.TaskLog.LogName"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The java profiler information.]]>
- </doc>
- </field>
- <field name="DEBUGOUT" type="org.apache.hadoop.mapred.TaskLog.LogName"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log the debug script's stdout]]>
- </doc>
- </field>
- <doc>
- <![CDATA[The filter for userlogs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskLog.LogName -->
- <!-- start class org.apache.hadoop.mapred.TaskLogAppender -->
- <class name="TaskLogAppender" extends="org.apache.log4j.FileAppender"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskLogAppender"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="activateOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="append"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
- </method>
- <method name="flush"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter/Setter methods for log4j.]]>
- </doc>
- </method>
- <method name="setTaskId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="java.lang.String"/>
- </method>
- <method name="getTotalLogFileSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTotalLogFileSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logSize" type="long"/>
- </method>
- <method name="setIsCleanup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="isCleanup" type="boolean"/>
- <doc>
- <![CDATA[Set whether the task is a cleanup attempt or not.
-
- @param isCleanup
- true if the task is cleanup attempt, false otherwise.]]>
- </doc>
- </method>
- <method name="getIsCleanup" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether task is cleanup attempt or not.
-
- @return true if the task is cleanup attempt, false otherwise.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A simple log4j-appender for the task child's
- map-reduce system logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskLogAppender -->
- <!-- start class org.apache.hadoop.mapred.TaskLogServlet -->
- <class name="TaskLogServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskLogServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTaskLogUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskTrackerHostName" type="java.lang.String"/>
- <param name="httpPort" type="java.lang.String"/>
- <param name="taskAttemptID" type="java.lang.String"/>
- <doc>
- <![CDATA[Construct the taskLogUrl
- @param taskTrackerHostName
- @param httpPort
- @param taskAttemptID
- @return the taskLogUrl]]>
- </doc>
- </method>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the logs via http.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A servlet that is run by the TaskTrackers to provide the task logs via http.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskLogServlet -->
- <!-- start class org.apache.hadoop.mapred.TaskLogsTruncater -->
- <class name="TaskLogsTruncater" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskLogsTruncater" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="shouldTruncateLogs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lInfo" type="org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check the log file sizes generated by the attempts that ran in a
- particular JVM
- @param lInfo
- @return is truncation required?
- @throws IOException]]>
- </doc>
- </method>
- <method name="truncateLogs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lInfo" type="org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo"/>
- <doc>
- <![CDATA[Process the removed task's logs. This involves truncating them to
- retainSize.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[The class for truncating the user logs.
- Should be used only by {@link UserLogManager}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskLogsTruncater -->
- <!-- start class org.apache.hadoop.mapred.TaskReport -->
- <class name="TaskReport" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TaskReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTaskId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getTaskID()} instead">
- <doc>
- <![CDATA[@deprecated use {@link #getTaskID()} instead]]>
- </doc>
- </method>
- <method name="getTaskID" return="org.apache.hadoop.mapred.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The id of the task.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The amount completed, between zero and one.]]>
- </doc>
- </method>
- <method name="getState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The most recent state, reported by a {@link Reporter}.]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A list of error messages.]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A table of counters.]]>
- </doc>
- </method>
- <method name="getCurrentStatus" return="org.apache.hadoop.mapred.TIPStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The current status]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get finish time of task.
- @return 0, if finish time was not set else returns finish time.]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get start time of task.
- @return 0 if start time was not set, else start time.]]>
- </doc>
- </method>
- <method name="setSuccessfulAttempt"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <doc>
- <![CDATA[set successful attempt ID of the task.]]>
- </doc>
- </method>
- <method name="getSuccessfulTaskAttempt" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt ID that took this task to completion]]>
- </doc>
- </method>
- <method name="setRunningTaskAttempts"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="runningAttempts" type="java.util.Collection"/>
- <doc>
- <![CDATA[set running attempt(s) of the task.]]>
- </doc>
- </method>
- <method name="getRunningTaskAttempts" return="java.util.Collection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the running task attempt IDs for this task]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A report on the state of a task.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskReport -->
- <!-- start class org.apache.hadoop.mapred.TaskStatus -->
- <class name="TaskStatus" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Cloneable"/>
- <constructor name="TaskStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TaskStatus" type="org.apache.hadoop.mapred.TaskAttemptID, float, int, org.apache.hadoop.mapred.TaskStatus.State, java.lang.String, java.lang.String, java.lang.String, org.apache.hadoop.mapred.TaskStatus.Phase, org.apache.hadoop.mapred.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTaskID" return="org.apache.hadoop.mapred.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getIsMap" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setProgress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- </method>
- <method name="getRunState" return="org.apache.hadoop.mapred.TaskStatus.State"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskTracker" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTaskTracker"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tracker" type="java.lang.String"/>
- </method>
- <method name="setRunState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="runState" type="org.apache.hadoop.mapred.TaskStatus.State"/>
- </method>
- <method name="getDiagnosticInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setDiagnosticInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="info" type="java.lang.String"/>
- </method>
- <method name="getStateString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setStateString"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stateString" type="java.lang.String"/>
- </method>
- <method name="getNextRecordRange" return="org.apache.hadoop.mapred.SortedRanges.Range"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the next record range which is going to be processed by Task.
- @return nextRecordRange]]>
- </doc>
- </method>
- <method name="setNextRecordRange"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nextRecordRange" type="org.apache.hadoop.mapred.SortedRanges.Range"/>
- <doc>
- <![CDATA[Set the next record range which is going to be processed by Task.
- @param nextRecordRange]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task finish time. if shuffleFinishTime and sortFinishTime
- are not set before, these are set to finishTime. It takes care of
- the case when shuffle, sort and finish are completed with in the
- heartbeat interval and are not reported separately. if task state is
- TaskStatus.FAILED then finish time represents when the task failed.
- @return finish time of the task.]]>
- </doc>
- </method>
- <method name="getShuffleFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get shuffle finish time for the task. If shuffle finish time was
- not set due to shuffle/sort/finish phases ending within same
- heartbeat interval, it is set to finish time of next phase i.e. sort
- or task finish when these are set.
- @return 0 if shuffleFinishTime, sortFinishTime and finish time are not set. else
- it returns approximate shuffle finish time.]]>
- </doc>
- </method>
- <method name="getSortFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get sort finish time for the task,. If sort finish time was not set
- due to sort and reduce phase finishing in same heartebat interval, it is
- set to finish time, when finish time is set.
- @return 0 if sort finish time and finish time are not set, else returns sort
- finish time if that is set, else it returns finish time.]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get start time of the task.
- @return 0 is start time is not set, else returns start time.]]>
- </doc>
- </method>
- <method name="getPhase" return="org.apache.hadoop.mapred.TaskStatus.Phase"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get current phase of this task. Phase.Map in case of map tasks,
- for reduce one of Phase.SHUFFLE, Phase.SORT or Phase.REDUCE.
- @return .]]>
- </doc>
- </method>
- <method name="getIncludeCounters" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIncludeCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="send" type="boolean"/>
- </method>
- <method name="getCounters" return="org.apache.hadoop.mapred.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task's counters.]]>
- </doc>
- </method>
- <method name="setCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
- <doc>
- <![CDATA[Set the task's counters.
- @param counters]]>
- </doc>
- </method>
- <method name="getOutputSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of bytes of output from this map.]]>
- </doc>
- </method>
- <method name="getFetchFailedMaps" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of maps from which output-fetches failed.
-
- @return the list of maps from which output-fetches failed.]]>
- </doc>
- </method>
- <method name="clone" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Describes the current status of a task. This is
- not intended to be a comprehensive piece of data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskStatus -->
- <!-- start class org.apache.hadoop.mapred.TaskStatus.Phase -->
- <class name="TaskStatus.Phase" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.TaskStatus.Phase[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.TaskStatus.Phase"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="STARTING" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHUFFLE" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SORT" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP" type="org.apache.hadoop.mapred.TaskStatus.Phase"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskStatus.Phase -->
- <!-- start class org.apache.hadoop.mapred.TaskStatus.State -->
- <class name="TaskStatus.State" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.TaskStatus.State[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.TaskStatus.State"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="RUNNING" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUCCEEDED" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNASSIGNED" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMIT_PENDING" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED_UNCLEAN" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED_UNCLEAN" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskStatus.State -->
- <!-- start class org.apache.hadoop.mapred.TaskTracker -->
- <class name="TaskTracker" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.MRConstants"/>
- <implements name="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
- <implements name="java.lang.Runnable"/>
- <implements name="org.apache.hadoop.mapred.TaskTrackerMXBean"/>
- <constructor name="TaskTracker" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Start with the local machine name, and the default JobTracker]]>
- </doc>
- </constructor>
- <method name="getTaskTrackerInstrumentation" return="org.apache.hadoop.mapred.TaskTrackerInstrumentation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskController" return="org.apache.hadoop.mapred.TaskController"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUserDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getPrivateDistributedCacheDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getPublicDistributedCacheDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobCacheSubdir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getLocalJobDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- </method>
- <method name="getJobJarFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- </method>
- <method name="getLocalTaskDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- <param name="taskid" type="java.lang.String"/>
- </method>
- <method name="getLocalTaskDir" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobid" type="java.lang.String"/>
- <param name="taskid" type="java.lang.String"/>
- <param name="isCleanupAttempt" type="boolean"/>
- </method>
- <method name="getProtocolVersion" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="protocol" type="java.lang.String"/>
- <param name="clientVersion" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="cleanupStorage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Removes all contents of temporary storage. Called upon
- startup, to remove any leftovers from previous run.]]>
- </doc>
- </method>
- <method name="launchTaskForJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="tip" type="org.apache.hadoop.mapred.TaskTracker.TaskInProgress"/>
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="rjob" type="org.apache.hadoop.mapred.TaskTracker.RunningJob"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="shutdown"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Close down the TaskTracker and all its components. We must also shutdown
- any running tasks or threads, and cleanup disk space. A new TaskTracker
- within the same process space might be restarted, so everything must be
- clean.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getJobClient" return="org.apache.hadoop.mapred.InterTrackerProtocol"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The connection to the JobTracker, used by the TaskRunner
- for locating remote files.]]>
- </doc>
- </method>
- <method name="getTaskTrackerReportAddress" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the port at which the tasktracker bound to]]>
- </doc>
- </method>
- <method name="getJvmManagerInstance" return="org.apache.hadoop.mapred.JvmManager"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The server retry loop.
- This while-loop attempts to connect to the JobTracker. It only
- loops when the old TaskTracker has gone bad (its state is
- stale somehow) and we need to reinitialize everything.]]>
- </doc>
- </method>
- <method name="getTask" return="org.apache.hadoop.mapred.JvmTask"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called upon startup by the child process, to fetch Task data.]]>
- </doc>
- </method>
- <method name="statusUpdate" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called periodically to report Task progress, from 0.0 to 1.0.]]>
- </doc>
- </method>
- <method name="reportDiagnosticInfo"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="info" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when the task dies before completion, and we want to report back
- diagnostic info]]>
- </doc>
- </method>
- <method name="reportNextRecordRange"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="range" type="org.apache.hadoop.mapred.SortedRanges.Range"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="ping" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Child checking to see if we're alive. Normally does nothing.]]>
- </doc>
- </method>
- <method name="commitPending"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Task is reporting that it is in commit_pending
- and it is waiting for the commit Response]]>
- </doc>
- </method>
- <method name="canCommit" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Child checking whether it can commit]]>
- </doc>
- </method>
- <method name="done"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The task is done.]]>
- </doc>
- </method>
- <method name="shuffleError"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="message" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A reduce-task failed to shuffle the map-outputs. Kill the task.]]>
- </doc>
- </method>
- <method name="fsError"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="message" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A child task had a local filesystem error. Kill the task.]]>
- </doc>
- </method>
- <method name="fatalError"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="msg" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A child task had a fatal error. Kill the task.]]>
- </doc>
- </method>
- <method name="getMapCompletionEvents" return="org.apache.hadoop.mapred.MapTaskCompletionEventsUpdate"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="fromEventId" type="int"/>
- <param name="maxLocs" type="int"/>
- <param name="id" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="mapOutputLost"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="errorMsg" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A completed map task's output has been lost.]]>
- </doc>
- </method>
- <method name="isIdle" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this task tracker idle?
- @return has this task tracker finished all its assigned tasks?]]>
- </doc>
- </method>
- <method name="isIdleAndClean" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is this task tracker idle and clean?
- @return has this task tracker finished and cleaned up all of its tasks?]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Start the TaskTracker, point toward the indicated JobTracker]]>
- </doc>
- </method>
- <method name="isTaskMemoryManagerEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is the TaskMemoryManager Enabled on this system?
- @return true if enabled, false otherwise.]]>
- </doc>
- </method>
- <method name="getTaskMemoryManager" return="org.apache.hadoop.mapred.TaskMemoryManagerThread"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getConfigVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobTrackerUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRpcPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHttpPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isHealthy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTasksInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="updatePrivateDistributedCacheSizes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="sizes" type="long[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MR_CLIENTTRACE_FORMAT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ClientTraceLog" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUBDIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TT_LOG_TMP_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TT_RESOURCE_CALCULATOR_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TT_USER_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TT_KEYTAB_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[TaskTracker is a process that starts and tracks MR Tasks
- in a networked environment. It contacts the JobTracker
- for Task assignments and reporting results.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskTracker -->
- <!-- start class org.apache.hadoop.mapred.TaskTracker.MapOutputServlet -->
- <class name="TaskTracker.MapOutputServlet" extends="javax.servlet.http.HttpServlet"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskTracker.MapOutputServlet"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doGet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <param name="response" type="javax.servlet.http.HttpServletResponse"/>
- <exception name="ServletException" type="javax.servlet.ServletException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class is used in TaskTracker's Jetty to serve the map outputs
- to other nodes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskTracker.MapOutputServlet -->
- <!-- start class org.apache.hadoop.mapred.TaskTrackerMetricsSource -->
- <class name="TaskTrackerMetricsSource" extends="org.apache.hadoop.mapred.TaskTrackerInstrumentation"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.metrics2.MetricsSource"/>
- <constructor name="TaskTrackerMetricsSource" type="org.apache.hadoop.mapred.TaskTracker"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="org.apache.hadoop.metrics2.MetricsBuilder"/>
- <param name="all" type="boolean"/>
- </method>
- <method name="completeTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- </method>
- <method name="timedoutTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- </method>
- <method name="taskFailedPing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- </method>
- <doc>
- <![CDATA[Instrumentation for metrics v2]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskTrackerMetricsSource -->
- <!-- start interface org.apache.hadoop.mapred.TaskTrackerMXBean -->
- <interface name="TaskTrackerMXBean" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the hostname of the tasktracker]]>
- </doc>
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the version of the code base]]>
- </doc>
- </method>
- <method name="getConfigVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the config version (from a config properties)]]>
- </doc>
- </method>
- <method name="getJobTrackerUrl" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the URL of the jobtracker]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the RPC port of the tasktracker]]>
- </doc>
- </method>
- <method name="getHttpPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the HTTP port of the tasktracker]]>
- </doc>
- </method>
- <method name="isHealthy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the health status of the tasktracker]]>
- </doc>
- </method>
- <method name="getTasksInfoJson" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a json formatted info about tasks of the tasktracker]]>
- </doc>
- </method>
- <doc>
- <![CDATA[MXBean interface for TaskTracker]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.TaskTrackerMXBean -->
- <!-- start class org.apache.hadoop.mapred.TaskTrackerStatus -->
- <class name="TaskTrackerStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="TaskTrackerStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TaskTrackerStatus" type="java.lang.String, java.lang.String, int, java.util.List, int, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTrackerName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHttpPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the port that this task tracker is serving http requests on.
- @return the http port]]>
- </doc>
- </method>
- <method name="getTaskFailures" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of tasks that have failed on this tracker.
- @return The number of failed tasks]]>
- </doc>
- </method>
- <method name="getDirFailures" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of local directories that have failed on this tracker.
- @return The number of failed local directories]]>
- </doc>
- </method>
- <method name="getTaskReports" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current tasks at the TaskTracker.
- Tasks are tracked by a {@link TaskStatus} object.
-
- @return a list of {@link TaskStatus} representing
- the current tasks at the TaskTracker.]]>
- </doc>
- </method>
- <method name="countMapTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of running map tasks.
- @return the number of running map tasks]]>
- </doc>
- </method>
- <method name="countOccupiedMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of occupied map slots.
- @return the number of occupied map slots]]>
- </doc>
- </method>
- <method name="getAvailableMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get available map slots.
- @return available map slots]]>
- </doc>
- </method>
- <method name="countReduceTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of running reduce tasks.
- @return the number of running reduce tasks]]>
- </doc>
- </method>
- <method name="countOccupiedReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of occupied reduce slots.
- @return the number of occupied reduce slots]]>
- </doc>
- </method>
- <method name="getAvailableReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get available reduce slots.
- @return available reduce slots]]>
- </doc>
- </method>
- <method name="getLastSeen" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setLastSeen"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="lastSeen" type="long"/>
- </method>
- <method name="getMaxMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum map slots for this node.
- @return the maximum map slots for this node]]>
- </doc>
- </method>
- <method name="getMaxReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum reduce slots for this node.
- @return the maximum reduce slots for this node]]>
- </doc>
- </method>
- <method name="getHealthStatus" return="org.apache.hadoop.mapred.TaskTrackerStatus.TaskTrackerHealthStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns health status of the task tracker.
- @return health status of Task Tracker]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNAVAILABLE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A TaskTrackerStatus is a MapReduce primitive. Keeps
- info on a TaskTracker. The JobTracker maintains a set
- of the most recent TaskTrackerStatus objects for each
- unique TaskTracker it knows about.
- This is NOT a public interface!]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TaskTrackerStatus -->
- <!-- start interface org.apache.hadoop.mapred.TaskUmbilicalProtocol -->
- <interface name="TaskUmbilicalProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.ipc.VersionedProtocol"/>
- <method name="getTask" return="org.apache.hadoop.mapred.JvmTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called when a child task process starts, to get its task.
- @param context the JvmContext of the JVM w.r.t the TaskTracker that
- launched it
- @return Task object
- @throws IOException]]>
- </doc>
- </method>
- <method name="statusUpdate" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Report child's progress to parent.
-
- @param taskId task-id of the child
- @param taskStatus status of the child
- @param jvmContext context the jvmContext running the task.
- @throws IOException
- @throws InterruptedException
- @return True if the task is known]]>
- </doc>
- </method>
- <method name="reportDiagnosticInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="trace" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report error messages back to parent. Calls should be sparing, since all
- such messages are held in the job tracker.
- @param taskid the id of the task involved
- @param trace the text to report
- @param jvmContext context the jvmContext running the task.]]>
- </doc>
- </method>
- <method name="reportNextRecordRange"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="range" type="org.apache.hadoop.mapred.SortedRanges.Range"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report the record range which is going to process next by the Task.
- @param taskid the id of the task involved
- @param range the range of record sequence nos
- @param jvmContext context the jvmContext running the task.
- @throws IOException]]>
- </doc>
- </method>
- <method name="ping" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Periodically called by child to check if parent is still alive.
- @param taskid the id of the task involved
- @param jvmContext context the jvmContext running the task.
- @return True if the task is known]]>
- </doc>
- </method>
- <method name="done"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report that the task is successfully completed. Failure is assumed if
- the task process exits without calling this.
- @param taskid task's id
- @param jvmContext context the jvmContext running the task.]]>
- </doc>
- </method>
- <method name="commitPending"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Report that the task is complete, but its commit is pending.
-
- @param taskId task's id
- @param taskStatus status of the child
- @param jvmContext context the jvmContext running the task.
- @throws IOException]]>
- </doc>
- </method>
- <method name="canCommit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Polling to know whether the task can go-ahead with commit
- @param taskid
- @param jvmContext context the jvmContext running the task.
- @return true/false
- @throws IOException]]>
- </doc>
- </method>
- <method name="shuffleError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="message" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report that a reduce-task couldn't shuffle map-outputs.]]>
- </doc>
- </method>
- <method name="fsError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="message" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report that the task encounted a local filesystem error.]]>
- </doc>
- </method>
- <method name="fatalError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="message" type="java.lang.String"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report that the task encounted a fatal error.]]>
- </doc>
- </method>
- <method name="getMapCompletionEvents" return="org.apache.hadoop.mapred.MapTaskCompletionEventsUpdate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
- <param name="fromIndex" type="int"/>
- <param name="maxLocs" type="int"/>
- <param name="id" type="org.apache.hadoop.mapred.TaskAttemptID"/>
- <param name="jvmContext" type="org.apache.hadoop.mapred.JvmContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called by a reduce task to get the map output locations for finished maps.
- Returns an update centered around the map-task-completion-events.
- The update also piggybacks the information whether the events copy at the
- task-tracker has changed or not. This will trigger some action at the
- child-process.
- @param jobId the reducer job id
- @param fromIndex the index starting from which the locations should be
- fetched
- @param maxLocs the max number of locations to fetch
- @param id The attempt id of the task that is trying to communicate
- @return A {@link MapTaskCompletionEventsUpdate}]]>
- </doc>
- </method>
- <method name="updatePrivateDistributedCacheSizes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="sizes" type="long[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The job initializer needs to report the sizes of the archive
- objects and directories in the private distributed cache.
- @param jobId the job to update
- @param sizes the array of sizes that were computed
- @throws IOException]]>
- </doc>
- </method>
- <field name="versionID" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Changed the version to 2, since we have a new method getMapOutputs
- Changed version to 3 to have progress() return a boolean
- Changed the version to 4, since we have replaced
- TaskUmbilicalProtocol.progress(String, float, String,
- org.apache.hadoop.mapred.TaskStatus.Phase, Counters)
- with statusUpdate(String, TaskStatus)
-
- Version 5 changed counters representation for HADOOP-2248
- Version 6 changes the TaskStatus representation for HADOOP-2208
- Version 7 changes the done api (via HADOOP-3140). It now expects whether
- or not the task's output needs to be promoted.
- Version 8 changes {job|tip|task}id's to use their corresponding
- objects rather than strings.
- Version 9 changes the counter representation for HADOOP-1915
- Version 10 changed the TaskStatus format and added reportNextRecordRange
- for HADOOP-153
- Version 11 Adds RPCs for task commit as part of HADOOP-3150
- Version 12 getMapCompletionEvents() now also indicates if the events are
- stale or not. Hence the return type is a class that
- encapsulates the events and whether to reset events index.
- Version 13 changed the getTask method signature for HADOOP-249
- Version 14 changed the getTask method signature for HADOOP-4232
- Version 15 Adds FAILED_UNCLEAN and KILLED_UNCLEAN states for HADOOP-4759
- Version 16 Added numRequiredSlots to TaskStatus for MAPREDUCE-516
- Version 17 Change in signature of getTask() for HADOOP-5488
- Version 18 Added fatalError for child to communicate fatal errors to TT
- Version 19 Added jvmContext to most method signatures for MAPREDUCE-2429]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Protocol that task child process uses to contact its parent process. The
- parent is a daemon which which polls the central master for a new map or
- reduce task and runs it as a child process. All communication between child
- and parent is via this protocol.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.TaskUmbilicalProtocol -->
- <!-- start class org.apache.hadoop.mapred.TextInputFormat -->
- <class name="TextInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="TextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
- Either linefeed or carriage-return are used to signal end of line. Keys are
- the position in the file, and values are the line of text..]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TextInputFormat -->
- <!-- start class org.apache.hadoop.mapred.TextOutputFormat -->
- <class name="TextOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TextOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes plain text files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TextOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.TextOutputFormat.LineRecordWriter -->
- <class name="TextOutputFormat.LineRecordWriter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordWriter"/>
- <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="out" type="java.io.DataOutputStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.TextOutputFormat.LineRecordWriter -->
- <!-- start class org.apache.hadoop.mapred.TIPStatus -->
- <class name="TIPStatus" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.TIPStatus[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.TIPStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="PENDING" type="org.apache.hadoop.mapred.TIPStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.mapred.TIPStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMPLETE" type="org.apache.hadoop.mapred.TIPStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapred.TIPStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapred.TIPStatus"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The states of a {@link TaskInProgress} as seen by the JobTracker.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.TIPStatus -->
- <!-- start class org.apache.hadoop.mapred.UserLogCleaner -->
- <class name="UserLogCleaner" extends="java.lang.Thread"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UserLogCleaner" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogManager, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deleteJobLogs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="addOldUserLogsForDeletion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="loc" type="java.io.File"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Adds the job log directories for deletion with default retain hours.
- Deletes all other directories, if any.
-
- @param loc location of log directory
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="clearOldUserLogs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Clears all the logs in userlogs directory. This is usually called on
- reinit/restart of the TaskTracker.
-
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="markJobLogsForDeletion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobCompletionTime" type="long"/>
- <param name="retainHours" type="int"/>
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <doc>
- <![CDATA[Adds job user-log directory to cleanup thread to delete logs after user-log
- retain hours.
-
- @param jobCompletionTime
- job completion time in millis
- @param retainHours
- the user-log retain hours for the job
- @param jobid
- JobID for which user logs should be deleted]]>
- </doc>
- </method>
- <method name="unmarkJobFromLogDeletion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobid" type="org.apache.hadoop.mapreduce.JobID"/>
- <doc>
- <![CDATA[Remove job from user log deletion.
-
- @param jobid]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is used only in UserLogManager, to manage cleanup of user logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.UserLogCleaner -->
- <!-- start class org.apache.hadoop.mapred.Utils -->
- <class name="Utils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Utils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A utility class. It provides
- - file-util
- - A path filter utility to filter out output/part files in the output dir]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Utils -->
- <!-- start class org.apache.hadoop.mapred.Utils.OutputFileUtils -->
- <class name="Utils.OutputFileUtils" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Utils.OutputFileUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.mapred.Utils.OutputFileUtils -->
- <!-- start class org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputFilesFilter -->
- <class name="Utils.OutputFileUtils.OutputFilesFilter" extends="org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputLogFilter"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Utils.OutputFileUtils.OutputFilesFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <doc>
- <![CDATA[This class filters output(part) files from the given directory
- It does not accept files with filenames _logs and _SUCCESS.
- This can be used to list paths of output directory as follows:
- Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,
- new OutputFilesFilter()));]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputFilesFilter -->
- <!-- start class org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputLogFilter -->
- <class name="Utils.OutputFileUtils.OutputLogFilter" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.fs.PathFilter"/>
- <constructor name="Utils.OutputFileUtils.OutputLogFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- </method>
- <doc>
- <![CDATA[This class filters log files from directory given
- It doesnt accept paths having _logs.
- This can be used to list paths of output directory as follows:
- Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,
- new OutputLogFilter()));]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.Utils.OutputFileUtils.OutputLogFilter -->
- </package>
- <package name="org.apache.hadoop.mapred.jobcontrol">
- <!-- start class org.apache.hadoop.mapred.jobcontrol.Job -->
- <class name="Job" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Job" type="org.apache.hadoop.mapred.JobConf, java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a job.
- @param jobConf a mapred job configuration representing a job to be executed.
- @param dependingJobs an array of jobs the current job depends on]]>
- </doc>
- </constructor>
- <constructor name="Job" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a job.
-
- @param jobConf mapred job configuration representing a job to be executed.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job name of this job]]>
- </doc>
- </method>
- <method name="setJobName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the job name for this job.
- @param jobName the job name]]>
- </doc>
- </method>
- <method name="getJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job ID of this job assigned by JobControl]]>
- </doc>
- </method>
- <method name="setJobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the job ID for this job.
- @param id the job ID]]>
- </doc>
- </method>
- <method name="getMapredJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #getAssignedJobID()} instead">
- <doc>
- <![CDATA[@return the mapred ID of this job
- @deprecated use {@link #getAssignedJobID()} instead]]>
- </doc>
- </method>
- <method name="setMapredJobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #setAssignedJobID(JobID)} instead">
- <param name="mapredJobID" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the mapred ID for this job.
- @param mapredJobID the mapred job ID for this job.
- @deprecated use {@link #setAssignedJobID(JobID)} instead]]>
- </doc>
- </method>
- <method name="getAssignedJobID" return="org.apache.hadoop.mapred.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the mapred ID of this job as assigned by the
- mapred framework.]]>
- </doc>
- </method>
- <method name="setAssignedJobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mapredJobID" type="org.apache.hadoop.mapred.JobID"/>
- <doc>
- <![CDATA[Set the mapred ID for this job as assigned by the
- mapred framework.
- @param mapredJobID the mapred job ID for this job.]]>
- </doc>
- </method>
- <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the mapred job conf of this job]]>
- </doc>
- </method>
- <method name="setJobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Set the mapred job conf for this job.
- @param jobConf the mapred job conf for this job.]]>
- </doc>
- </method>
- <method name="getState" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the state of this job]]>
- </doc>
- </method>
- <method name="setState"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="state" type="int"/>
- <doc>
- <![CDATA[Set the state for this job.
- @param state the new state for this job.]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the message of this job]]>
- </doc>
- </method>
- <method name="setMessage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="message" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the message for this job.
- @param message the message for this job.]]>
- </doc>
- </method>
- <method name="getJobClient" return="org.apache.hadoop.mapred.JobClient"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job client of this job]]>
- </doc>
- </method>
- <method name="getDependingJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the depending jobs of this job]]>
- </doc>
- </method>
- <method name="addDependingJob" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dependingJob" type="org.apache.hadoop.mapred.jobcontrol.Job"/>
- <doc>
- <![CDATA[Add a job to this jobs' dependency list. Dependent jobs can only be added while a Job
- is waiting to run, not during or afterwards.
-
- @param dependingJob Job that this Job depends on.
- @return <tt>true</tt> if the Job was added.]]>
- </doc>
- </method>
- <method name="isCompleted" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this job is in a complete state]]>
- </doc>
- </method>
- <method name="isReady" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this job is in READY state]]>
- </doc>
- </method>
- <method name="submit"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Submit this job to mapred. The state becomes RUNNING if submission
- is successful, FAILED otherwise.]]>
- </doc>
- </method>
- <field name="SUCCESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WAITING" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEPENDENT_FAILED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class encapsulates a MapReduce job and its dependency. It monitors
- the states of the depending jobs and updates the state of this job.
- A job starts in the WAITING state. If it does not have any depending jobs, or
- all of the depending jobs are in SUCCESS state, then the job state will become
- READY. If any depending jobs fail, the job will fail too.
- When in READY state, the job can be submitted to Hadoop for execution, with
- the state changing into RUNNING state. From RUNNING state, the job can get into
- SUCCESS or FAILED state, depending the status of the job execution.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.jobcontrol.Job -->
- <!-- start class org.apache.hadoop.mapred.jobcontrol.JobControl -->
- <class name="JobControl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Runnable"/>
- <constructor name="JobControl" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a job control for a group of jobs.
- @param groupName a name identifying this group]]>
- </doc>
- </constructor>
- <method name="getWaitingJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the waiting state]]>
- </doc>
- </method>
- <method name="getRunningJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the running state]]>
- </doc>
- </method>
- <method name="getReadyJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the ready state]]>
- </doc>
- </method>
- <method name="getSuccessfulJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the success state]]>
- </doc>
- </method>
- <method name="getFailedJobs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addJob" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aJob" type="org.apache.hadoop.mapred.jobcontrol.Job"/>
- <doc>
- <![CDATA[Add a new job.
- @param aJob the new job]]>
- </doc>
- </method>
- <method name="addJobs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobs" type="java.util.Collection"/>
- <doc>
- <![CDATA[Add a collection of jobs
-
- @param jobs]]>
- </doc>
- </method>
- <method name="getState" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the thread state]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[set the thread state to STOPPING so that the
- thread will stop when it wakes up.]]>
- </doc>
- </method>
- <method name="suspend"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[suspend the running thread]]>
- </doc>
- </method>
- <method name="resume"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[resume the suspended thread]]>
- </doc>
- </method>
- <method name="allFinished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The main loop for the thread.
- The loop does the following:
- Check the states of the running jobs
- Update the states of waiting jobs
- Submit the jobs in ready state]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class encapsulates a set of MapReduce jobs and its dependency. It tracks
- the states of the jobs by placing them into different tables according to their
- states.
-
- This class provides APIs for the client app to add a job to the group and to get
- the jobs in the group in different states. When a
- job is added, an ID unique to the group is assigned to the job.
-
- This class has a thread that submits jobs when they become ready, monitors the
- states of the running jobs, and updates the states of jobs based on the state changes
- of their depending jobs states. The class provides APIs for suspending/resuming
- the thread,and for stopping the thread.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.jobcontrol.JobControl -->
- </package>
- <package name="org.apache.hadoop.mapred.join">
- <!-- start class org.apache.hadoop.mapred.join.ArrayListBackedIterator -->
- <class name="ArrayListBackedIterator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
- <constructor name="ArrayListBackedIterator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ArrayListBackedIterator" type="java.util.ArrayList"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This class provides an implementation of ResetableIterator. The
- implementation uses an {@link java.util.ArrayList} to store elements
- added to it, replaying them as requested.
- Prefer {@link StreamBackedIterator}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.ArrayListBackedIterator -->
- <!-- start interface org.apache.hadoop.mapred.join.ComposableInputFormat -->
- <interface name="ComposableInputFormat" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputFormat"/>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.join.ComposableRecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Refinement of InputFormat requiring implementors to provide
- ComposableRecordReader instead of RecordReader.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.join.ComposableInputFormat -->
- <!-- start interface org.apache.hadoop.mapred.join.ComposableRecordReader -->
- <interface name="ComposableRecordReader" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <implements name="java.lang.Comparable"/>
- <method name="id" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the position in the collector this class occupies.]]>
- </doc>
- </method>
- <method name="key" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the key this RecordReader would supply on a call to next(K,V)]]>
- </doc>
- </method>
- <method name="key"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Clone the key at the head of this RecordReader into the object provided.]]>
- </doc>
- </method>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns true if the stream is not empty, but provides no guarantee that
- a call to next(K,V) will succeed.]]>
- </doc>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skip key-value pairs with keys less than or equal to the key provided.]]>
- </doc>
- </method>
- <method name="accept"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[While key-value pairs from this RecordReader match the given key, register
- them with the JoinCollector provided.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Additional operations required of a RecordReader to participate in a join.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.join.ComposableRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.CompositeInputFormat -->
- <class name="CompositeInputFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ComposableInputFormat"/>
- <constructor name="CompositeInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setFormat"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Interpret a given string as a composite expression.
- {@code
- func ::= <ident>([<func>,]*<func>)
- func ::= tbl(<class>,"<path>")
- class ::= @see java.lang.Class#forName(java.lang.String)
- path ::= @see org.apache.hadoop.fs.Path#Path(java.lang.String)
- }
- Reads expression from the <tt>mapred.join.expr</tt> property and
- user-supplied join types from <tt>mapred.join.define.<ident></tt>
- types. Paths supplied to <tt>tbl</tt> are given as input paths to the
- InputFormat class listed.
- @see #compose(java.lang.String, java.lang.Class, java.lang.String...)]]>
- </doc>
- </method>
- <method name="addDefaults"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Adds the default set of identifiers to the parser.]]>
- </doc>
- </method>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Build a CompositeInputSplit from the child InputFormats by assigning the
- ith split from each child to the ith composite split.]]>
- </doc>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.join.ComposableRecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a CompositeRecordReader for the children of this InputFormat
- as defined in the init expression.
- The outermost join need only be composable, not necessarily a composite.
- Mandating TupleWritable isn't strictly correct.]]>
- </doc>
- </method>
- <method name="compose" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="java.lang.Class"/>
- <param name="path" type="java.lang.String"/>
- <doc>
- <![CDATA[Convenience method for constructing composite formats.
- Given InputFormat class (inf), path (p) return:
- {@code tbl(<inf>, <p>) }]]>
- </doc>
- </method>
- <method name="compose" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="op" type="java.lang.String"/>
- <param name="inf" type="java.lang.Class"/>
- <param name="path" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Convenience method for constructing composite formats.
- Given operation (op), Object class (inf), set of paths (p) return:
- {@code <op>(tbl(<inf>,<p1>),tbl(<inf>,<p2>),...,tbl(<inf>,<pn>)) }]]>
- </doc>
- </method>
- <method name="compose" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="op" type="java.lang.String"/>
- <param name="inf" type="java.lang.Class"/>
- <param name="path" type="org.apache.hadoop.fs.Path[]"/>
- <doc>
- <![CDATA[Convenience method for constructing composite formats.
- Given operation (op), Object class (inf), set of paths (p) return:
- {@code <op>(tbl(<inf>,<p1>),tbl(<inf>,<p2>),...,tbl(<inf>,<pn>)) }]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An InputFormat capable of performing joins over a set of data sources sorted
- and partitioned the same way.
- @see #setFormat
- A user may define new join types by setting the property
- <tt>mapred.join.define.<ident></tt> to a classname. In the expression
- <tt>mapred.join.expr</tt>, the identifier will be assumed to be a
- ComposableRecordReader.
- <tt>mapred.join.keycomparator</tt> can be a classname used to compare keys
- in the join.
- @see JoinRecordReader
- @see MultiFilterRecordReader]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.CompositeInputFormat -->
- <!-- start class org.apache.hadoop.mapred.join.CompositeInputSplit -->
- <class name="CompositeInputSplit" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputSplit"/>
- <constructor name="CompositeInputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CompositeInputSplit" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="s" type="org.apache.hadoop.mapred.InputSplit"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add an InputSplit to this collection.
- @throws IOException If capacity was not specified during construction
- or if capacity has been reached.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.mapred.InputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Get ith child InputSplit.]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the aggregate length of all child InputSplits currently added.]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the length of ith child InputSplit.]]>
- </doc>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Collect a set of hosts from all child InputSplits.]]>
- </doc>
- </method>
- <method name="getLocation" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[getLocations from ith InputSplit.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write splits in the following format.
- {@code
- <count><class1><class2>...<classn><split1><split2>...<splitn>
- }]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}
- @throws IOException If the child InputSplit cannot be read, typically
- for faliing access checks.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This InputSplit contains a set of child InputSplits. Any InputSplit inserted
- into this collection must have a public default constructor.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.CompositeInputSplit -->
- <!-- start class org.apache.hadoop.mapred.join.CompositeRecordReader -->
- <class name="CompositeRecordReader" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="CompositeRecordReader" type="int, int, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a RecordReader with <tt>capacity</tt> children to position
- <tt>id</tt> in the parent reader.
- The id of a root CompositeRecordReader is -1 by convention, but relying
- on this is not recommended.]]>
- </doc>
- </constructor>
- <method name="combine" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="srcs" type="java.lang.Object[]"/>
- <param name="value" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- </method>
- <method name="id" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the position in the collector this class occupies.]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getRecordReaderQueue" return="java.util.PriorityQueue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return sorted list of RecordReaders for this composite.]]>
- </doc>
- </method>
- <method name="getComparator" return="org.apache.hadoop.io.WritableComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return comparator defining the ordering for RecordReaders in this
- composite.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rr" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a RecordReader to this collection.
- The id() of a RecordReader determines where in the Tuple its
- entry will appear. Adding RecordReaders with the same id has
- undefined behavior.]]>
- </doc>
- </method>
- <method name="key" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the key for the current join or the value at the top of the
- RecordReader heap.]]>
- </doc>
- </method>
- <method name="key"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Clone the key at the top of this RR into the given object.]]>
- </doc>
- </method>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if it is possible that this could emit more values.]]>
- </doc>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Pass skip key to child RRs.]]>
- </doc>
- </method>
- <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Obtain an iterator over the child RRs apropos of the value type
- ultimately emitted from this join.]]>
- </doc>
- </method>
- <method name="accept"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[If key provided matches that of this Composite, give JoinCollector
- iterator over values it may emit.]]>
- </doc>
- </method>
- <method name="fillJoinCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="iterkey" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For all child RRs offering the key provided, obtain an iterator
- at that position in the JoinCollector.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <doc>
- <![CDATA[Implement Comparable contract (compare key of join or head of heap
- with that of another).]]>
- </doc>
- </method>
- <method name="createKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new key value common to all child RRs.
- @throws ClassCastException if key classes differ.]]>
- </doc>
- </method>
- <method name="createInternalValue" return="org.apache.hadoop.mapred.join.TupleWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a value to be used internally for joins.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Unsupported (returns zero in all cases).]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close all child RRs.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Report progress as the minimum of all child RR progress.]]>
- </doc>
- </method>
- <field name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="kids" type="org.apache.hadoop.mapred.join.ComposableRecordReader[]"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A RecordReader that can effect joins of RecordReaders sharing a common key
- type and partitioning.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.CompositeRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.InnerJoinRecordReader -->
- <class name="InnerJoinRecordReader" extends="org.apache.hadoop.mapred.join.JoinRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="combine" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="srcs" type="java.lang.Object[]"/>
- <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <doc>
- <![CDATA[Return true iff the tuple is full (all data sources contain this key).]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Full inner join.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.InnerJoinRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.JoinRecordReader -->
- <class name="JoinRecordReader" extends="org.apache.hadoop.mapred.join.CompositeRecordReader"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <constructor name="JoinRecordReader" type="int, org.apache.hadoop.mapred.JobConf, int, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Emit the next set of key, value pairs as defined by the child
- RecordReaders and operation associated with this composite RR.]]>
- </doc>
- </method>
- <method name="createValue" return="org.apache.hadoop.mapred.join.TupleWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return an iterator wrapping the JoinCollector.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Base class for Composite joins returning Tuples of arbitrary Writables.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.JoinRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.JoinRecordReader.JoinDelegationIterator -->
- <class name="JoinRecordReader.JoinDelegationIterator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
- <constructor name="JoinRecordReader.JoinDelegationIterator"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Since the JoinCollector is effecting our operation, we need only
- provide an iterator proxy wrapping its operation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.JoinRecordReader.JoinDelegationIterator -->
- <!-- start class org.apache.hadoop.mapred.join.MultiFilterRecordReader -->
- <class name="MultiFilterRecordReader" extends="org.apache.hadoop.mapred.join.CompositeRecordReader"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <constructor name="MultiFilterRecordReader" type="int, org.apache.hadoop.mapred.JobConf, int, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="emit" return="org.apache.hadoop.io.Writable"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For each tuple emitted, return a value (typically one of the values
- in the tuple).
- Modifying the Writables in the tuple is permitted and unlikely to affect
- join behavior in most cases, but it is not recommended. It's safer to
- clone first.]]>
- </doc>
- </method>
- <method name="combine" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="srcs" type="java.lang.Object[]"/>
- <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <doc>
- <![CDATA[Default implementation offers {@link #emit} every Tuple from the
- collector (the outer join of child RRs).]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createValue" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return an iterator returning a single value from the tuple.
- @see MultiFilterDelegationIterator]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Base class for Composite join returning values derived from multiple
- sources, but generally not tuples.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.MultiFilterRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.MultiFilterRecordReader.MultiFilterDelegationIterator -->
- <class name="MultiFilterRecordReader.MultiFilterDelegationIterator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
- <constructor name="MultiFilterRecordReader.MultiFilterDelegationIterator"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Proxy the JoinCollector, but include callback to emit.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.MultiFilterRecordReader.MultiFilterDelegationIterator -->
- <!-- start class org.apache.hadoop.mapred.join.OuterJoinRecordReader -->
- <class name="OuterJoinRecordReader" extends="org.apache.hadoop.mapred.join.JoinRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="combine" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="srcs" type="java.lang.Object[]"/>
- <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <doc>
- <![CDATA[Emit everything from the collector.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Full outer join.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.OuterJoinRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.OverrideRecordReader -->
- <class name="OverrideRecordReader" extends="org.apache.hadoop.mapred.join.MultiFilterRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="emit" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
- <doc>
- <![CDATA[Emit the value with the highest position in the tuple.]]>
- </doc>
- </method>
- <method name="fillJoinCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="iterkey" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Instead of filling the JoinCollector with iterators from all
- data sources, fill only the rightmost for this key.
- This not only saves space by discarding the other sources, but
- it also emits the number of key-value pairs in the preferred
- RecordReader instead of repeating that stream n times, where
- n is the cardinality of the cross product of the discarded
- streams for the given key.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Prefer the "rightmost" data source for this key.
- For example, <tt>override(S1,S2,S3)</tt> will prefer values
- from S3 over S2, and values from S2 over S1 for all keys
- emitted from all sources.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.OverrideRecordReader -->
- <!-- start class org.apache.hadoop.mapred.join.Parser -->
- <class name="Parser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Parser"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Very simple shift-reduce parser for join expressions.
- This should be sufficient for the user extension permitted now, but ought to
- be replaced with a parser generator if more complex grammars are supported.
- In particular, this "shift-reduce" parser has no states. Each set
- of formals requires a different internal node type, which is responsible for
- interpreting the list of tokens it receives. This is sufficient for the
- current grammar, but it has several annoying properties that might inhibit
- extension. In particular, parenthesis are always function calls; an
- algebraic or filter grammar would not only require a node type, but must
- also work around the internals of this parser.
- For most other cases, adding classes to the hierarchy- particularly by
- extending JoinRecordReader and MultiFilterRecordReader- is fairly
- straightforward. One need only override the relevant method(s) (usually only
- {@link CompositeRecordReader#combine}) and include a property to map its
- value to an identifier in the parser.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.Node -->
- <class name="Parser.Node" extends="java.lang.Object"
- abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ComposableInputFormat"/>
- <constructor name="Parser.Node" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="addIdentifier"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="ident" type="java.lang.String"/>
- <param name="mcstrSig" type="java.lang.Class[]"/>
- <param name="nodetype" type="java.lang.Class"/>
- <param name="cl" type="java.lang.Class"/>
- <exception name="NoSuchMethodException" type="java.lang.NoSuchMethodException"/>
- <doc>
- <![CDATA[For a given identifier, add a mapping to the nodetype for the parse
- tree and to the ComposableRecordReader to be created, including the
- formals required to invoke the constructor.
- The nodetype and constructor signature should be filled in from the
- child node.]]>
- </doc>
- </method>
- <method name="setID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="id" type="int"/>
- </method>
- <method name="setKeyComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="cmpcl" type="java.lang.Class"/>
- </method>
- <field name="rrCstrMap" type="java.util.Map"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="id" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="ident" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="cmpcl" type="java.lang.Class"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.Node -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.NodeToken -->
- <class name="Parser.NodeToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getNode" return="org.apache.hadoop.mapred.join.Parser.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.NodeToken -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.NumToken -->
- <class name="Parser.NumToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Parser.NumToken" type="double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNum" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.NumToken -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.StrToken -->
- <class name="Parser.StrToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Parser.StrToken" type="org.apache.hadoop.mapred.join.Parser.TType, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getStr" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.StrToken -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.Token -->
- <class name="Parser.Token" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getType" return="org.apache.hadoop.mapred.join.Parser.TType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNode" return="org.apache.hadoop.mapred.join.Parser.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getNum" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getStr" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Tagged-union type for tokens from the join expression.
- @see Parser.TType]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.Token -->
- <!-- start class org.apache.hadoop.mapred.join.Parser.TType -->
- <class name="Parser.TType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapred.join.Parser.TType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapred.join.Parser.TType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="CIF" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IDENT" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="COMMA" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LPAREN" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RPAREN" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="QUOT" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NUM" type="org.apache.hadoop.mapred.join.Parser.TType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.Parser.TType -->
- <!-- start interface org.apache.hadoop.mapred.join.ResetableIterator -->
- <interface name="ResetableIterator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[True if a call to next may return a value. This is permitted false
- positives, but not false negatives.]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Assign next value to actual.
- It is required that elements added to a ResetableIterator be returned in
- the same order after a call to {@link #reset} (FIFO).
- Note that a call to this may fail for nested joins (i.e. more elements
- available, but none satisfying the constraints of the join)]]>
- </doc>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Assign last value returned to actual.]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set iterator to return to the start of its range. Must be called after
- calling {@link #add} to avoid a ConcurrentModificationException.]]>
- </doc>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add an element to the collection of elements to iterate over.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close datasources and release resources. Calling methods on the iterator
- after calling close has undefined behavior.]]>
- </doc>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Close datasources, but do not release internal resources. Calling this
- method should permit the object to be reused with a different datasource.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This defines an interface to a stateful Iterator that can replay elements
- added to it directly.
- Note that this does not extend {@link java.util.Iterator}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.join.ResetableIterator -->
- <!-- start class org.apache.hadoop.mapred.join.ResetableIterator.EMPTY -->
- <class name="ResetableIterator.EMPTY" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
- <constructor name="ResetableIterator.EMPTY"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.ResetableIterator.EMPTY -->
- <!-- start class org.apache.hadoop.mapred.join.StreamBackedIterator -->
- <class name="StreamBackedIterator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
- <constructor name="StreamBackedIterator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="replay" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="add"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="item" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clear"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This class provides an implementation of ResetableIterator. This
- implementation uses a byte array to store elements added to it.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.StreamBackedIterator -->
- <!-- start class org.apache.hadoop.mapred.join.TupleWritable -->
- <class name="TupleWritable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Iterable"/>
- <constructor name="TupleWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty tuple with no allocated storage for writables.]]>
- </doc>
- </constructor>
- <constructor name="TupleWritable" type="org.apache.hadoop.io.Writable[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initialize tuple with storage; unknown whether any of them contain
- "written" values.]]>
- </doc>
- </constructor>
- <method name="has" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Return true if tuple has an element at the position provided.]]>
- </doc>
- </method>
- <method name="get" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Get ith Writable from Tuple.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of children in this Tuple.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return an iterator over the elements in this tuple.
- Note that this doesn't flatten the tuple; one may receive tuples
- from this iterator.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convert Tuple to String as in the following.
- <tt>[<child1>,<child2>,...,<childn>]</tt>]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes each Writable to <code>out</code>.
- TupleWritable format:
- {@code
- <count><type1><type2>...<typen><obj1><obj2>...<objn>
- }]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Writable type storing multiple {@link org.apache.hadoop.io.Writable}s.
- This is *not* a general-purpose tuple type. In almost all cases, users are
- encouraged to implement their own serializable types, which can perform
- better validation and provide more efficient encodings than this class is
- capable. TupleWritable relies on the join framework for type safety and
- assumes its instances will rarely be persisted, assumptions not only
- incompatible with, but contrary to the general case.
- @see org.apache.hadoop.io.Writable]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.TupleWritable -->
- <!-- start class org.apache.hadoop.mapred.join.WrappedRecordReader -->
- <class name="WrappedRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <method name="id" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="key" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the key at the head of this RR.]]>
- </doc>
- </method>
- <method name="key"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="qkey" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Clone the key at the head of this RR into the object supplied.]]>
- </doc>
- </method>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return true if the RR- including the k,v pair stored in this object-
- is exhausted.]]>
- </doc>
- </method>
- <method name="skip"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Skip key-value pairs with keys less than or equal to the key provided.]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the next k,v pair into the head of this object; return true iff
- the RR and this are exhausted.]]>
- </doc>
- </method>
- <method name="accept"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add an iterator to the collector at the position occupied by this
- RecordReader over the values in this stream paired with the key
- provided (ie register a stream of values from this source matching K
- with a collector).]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write key-value pair at the head of this stream to the objects provided;
- get next key-value pair from proxied RR.]]>
- </doc>
- </method>
- <method name="createKey" return="org.apache.hadoop.io.WritableComparable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Request new key from proxied RR.]]>
- </doc>
- </method>
- <method name="createValue" return="org.apache.hadoop.io.Writable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Request new value from proxied RR.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Request progress from proxied RR.]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Request position from proxied RR.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Forward close request to proxied RR.]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
- <doc>
- <![CDATA[Implement Comparable contract (compare key at head of proxied RR
- with that of another).]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- <doc>
- <![CDATA[Return true iff compareTo(other) retn true.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Proxy class for a RecordReader participating in the join framework.
- This class keeps track of the "head" key-value pair for the
- provided RecordReader and keeps a store of values matching a key when
- this source is participating in a join.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.join.WrappedRecordReader -->
- </package>
- <package name="org.apache.hadoop.mapred.lib">
- <!-- start class org.apache.hadoop.mapred.lib.BinaryPartitioner -->
- <class name="BinaryPartitioner" extends="org.apache.hadoop.mapreduce.lib.partition.BinaryPartitioner"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Partitioner"/>
- <constructor name="BinaryPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <doc>
- <![CDATA[Partition {@link BinaryComparable} keys using a configurable part of
- the bytes array returned by {@link BinaryComparable#getBytes()}.
-
- @see org.apache.hadoop.mapreduce.lib.partition.BinaryPartitioner]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.BinaryPartitioner -->
- <!-- start class org.apache.hadoop.mapred.lib.ChainMapper -->
- <class name="ChainMapper" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="ChainMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.]]>
- </doc>
- </constructor>
- <method name="addMapper"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="klass" type="java.lang.Class"/>
- <param name="inputKeyClass" type="java.lang.Class"/>
- <param name="inputValueClass" type="java.lang.Class"/>
- <param name="outputKeyClass" type="java.lang.Class"/>
- <param name="outputValueClass" type="java.lang.Class"/>
- <param name="byValue" type="boolean"/>
- <param name="mapperConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Adds a Mapper class to the chain job's JobConf.
- <p/>
- It has to be specified how key and values are passed from one element of
- the chain to the next, by value or by reference. If a Mapper leverages the
- assumed semantics that the key and values are not modified by the collector
- 'by value' must be used. If the Mapper does not expect this semantics, as
- an optimization to avoid serialization and deserialization 'by reference'
- can be used.
- <p/>
- For the added Mapper the configuration given for it,
- <code>mapperConf</code>, have precedence over the job's JobConf. This
- precedence is in effect when the task is running.
- <p/>
- IMPORTANT: There is no need to specify the output key/value classes for the
- ChainMapper, this is done by the addMapper for the last mapper in the chain
- <p/>
- @param job job's JobConf to add the Mapper class.
- @param klass the Mapper class to add.
- @param inputKeyClass mapper input key class.
- @param inputValueClass mapper input value class.
- @param outputKeyClass mapper output key class.
- @param outputValueClass mapper output value class.
- @param byValue indicates if key/values should be passed by value
- to the next Mapper in the chain, if any.
- @param mapperConf a JobConf with the configuration for the Mapper
- class. It is recommended to use a JobConf without default values using the
- <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Configures the ChainMapper and all the Mappers in the chain.
- <p/>
- If this method is overriden <code>super.configure(...)</code> should be
- invoked at the beginning of the overwriter method.]]>
- </doc>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Chains the <code>map(...)</code> methods of the Mappers in the chain.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes the ChainMapper and all the Mappers in the chain.
- <p/>
- If this method is overriden <code>super.close()</code> should be
- invoked at the end of the overwriter method.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The ChainMapper class allows to use multiple Mapper classes within a single
- Map task.
- <p/>
- The Mapper classes are invoked in a chained (or piped) fashion, the output of
- the first becomes the input of the second, and so on until the last Mapper,
- the output of the last Mapper will be written to the task's output.
- <p/>
- The key functionality of this feature is that the Mappers in the chain do not
- need to be aware that they are executed in a chain. This enables having
- reusable specialized Mappers that can be combined to perform composite
- operations within a single task.
- <p/>
- Special care has to be taken when creating chains that the key/values output
- by a Mapper are valid for the following Mapper in the chain. It is assumed
- all Mappers and the Reduce in the chain use maching output and input key and
- value classes as no conversion is done by the chaining code.
- <p/>
- Using the ChainMapper and the ChainReducer classes is possible to compose
- Map/Reduce jobs that look like <code>[MAP+ / REDUCE MAP*]</code>. And
- immediate benefit of this pattern is a dramatic reduction in disk IO.
- <p/>
- IMPORTANT: There is no need to specify the output key/value classes for the
- ChainMapper, this is done by the addMapper for the last mapper in the chain.
- <p/>
- ChainMapper usage pattern:
- <p/>
- <pre>
- ...
- conf.setJobName("chain");
- conf.setInputFormat(TextInputFormat.class);
- conf.setOutputFormat(TextOutputFormat.class);
- <p/>
- JobConf mapAConf = new JobConf(false);
- ...
- ChainMapper.addMapper(conf, AMap.class, LongWritable.class, Text.class,
- Text.class, Text.class, true, mapAConf);
- <p/>
- JobConf mapBConf = new JobConf(false);
- ...
- ChainMapper.addMapper(conf, BMap.class, Text.class, Text.class,
- LongWritable.class, Text.class, false, mapBConf);
- <p/>
- JobConf reduceConf = new JobConf(false);
- ...
- ChainReducer.setReducer(conf, XReduce.class, LongWritable.class, Text.class,
- Text.class, Text.class, true, reduceConf);
- <p/>
- ChainReducer.addMapper(conf, CMap.class, Text.class, Text.class,
- LongWritable.class, Text.class, false, null);
- <p/>
- ChainReducer.addMapper(conf, DMap.class, LongWritable.class, Text.class,
- LongWritable.class, LongWritable.class, true, null);
- <p/>
- FileInputFormat.setInputPaths(conf, inDir);
- FileOutputFormat.setOutputPath(conf, outDir);
- ...
- <p/>
- JobClient jc = new JobClient(conf);
- RunningJob job = jc.submitJob(conf);
- ...
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.ChainMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.ChainReducer -->
- <class name="ChainReducer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Reducer"/>
- <constructor name="ChainReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.]]>
- </doc>
- </constructor>
- <method name="setReducer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="klass" type="java.lang.Class"/>
- <param name="inputKeyClass" type="java.lang.Class"/>
- <param name="inputValueClass" type="java.lang.Class"/>
- <param name="outputKeyClass" type="java.lang.Class"/>
- <param name="outputValueClass" type="java.lang.Class"/>
- <param name="byValue" type="boolean"/>
- <param name="reducerConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Sets the Reducer class to the chain job's JobConf.
- <p/>
- It has to be specified how key and values are passed from one element of
- the chain to the next, by value or by reference. If a Reducer leverages the
- assumed semantics that the key and values are not modified by the collector
- 'by value' must be used. If the Reducer does not expect this semantics, as
- an optimization to avoid serialization and deserialization 'by reference'
- can be used.
- <p/>
- For the added Reducer the configuration given for it,
- <code>reducerConf</code>, have precedence over the job's JobConf. This
- precedence is in effect when the task is running.
- <p/>
- IMPORTANT: There is no need to specify the output key/value classes for the
- ChainReducer, this is done by the setReducer or the addMapper for the last
- element in the chain.
- @param job job's JobConf to add the Reducer class.
- @param klass the Reducer class to add.
- @param inputKeyClass reducer input key class.
- @param inputValueClass reducer input value class.
- @param outputKeyClass reducer output key class.
- @param outputValueClass reducer output value class.
- @param byValue indicates if key/values should be passed by value
- to the next Mapper in the chain, if any.
- @param reducerConf a JobConf with the configuration for the Reducer
- class. It is recommended to use a JobConf without default values using the
- <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
- </doc>
- </method>
- <method name="addMapper"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="klass" type="java.lang.Class"/>
- <param name="inputKeyClass" type="java.lang.Class"/>
- <param name="inputValueClass" type="java.lang.Class"/>
- <param name="outputKeyClass" type="java.lang.Class"/>
- <param name="outputValueClass" type="java.lang.Class"/>
- <param name="byValue" type="boolean"/>
- <param name="mapperConf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Adds a Mapper class to the chain job's JobConf.
- <p/>
- It has to be specified how key and values are passed from one element of
- the chain to the next, by value or by reference. If a Mapper leverages the
- assumed semantics that the key and values are not modified by the collector
- 'by value' must be used. If the Mapper does not expect this semantics, as
- an optimization to avoid serialization and deserialization 'by reference'
- can be used.
- <p/>
- For the added Mapper the configuration given for it,
- <code>mapperConf</code>, have precedence over the job's JobConf. This
- precedence is in effect when the task is running.
- <p/>
- IMPORTANT: There is no need to specify the output key/value classes for the
- ChainMapper, this is done by the addMapper for the last mapper in the chain
- .
- @param job chain job's JobConf to add the Mapper class.
- @param klass the Mapper class to add.
- @param inputKeyClass mapper input key class.
- @param inputValueClass mapper input value class.
- @param outputKeyClass mapper output key class.
- @param outputValueClass mapper output value class.
- @param byValue indicates if key/values should be passed by value
- to the next Mapper in the chain, if any.
- @param mapperConf a JobConf with the configuration for the Mapper
- class. It is recommended to use a JobConf without default values using the
- <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Configures the ChainReducer, the Reducer and all the Mappers in the chain.
- <p/>
- If this method is overriden <code>super.configure(...)</code> should be
- invoked at the beginning of the overwriter method.]]>
- </doc>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Chains the <code>reduce(...)</code> method of the Reducer with the
- <code>map(...) </code> methods of the Mappers in the chain.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes the ChainReducer, the Reducer and all the Mappers in the chain.
- <p/>
- If this method is overriden <code>super.close()</code> should be
- invoked at the end of the overwriter method.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The ChainReducer class allows to chain multiple Mapper classes after a
- Reducer within the Reducer task.
- <p/>
- For each record output by the Reducer, the Mapper classes are invoked in a
- chained (or piped) fashion, the output of the first becomes the input of the
- second, and so on until the last Mapper, the output of the last Mapper will
- be written to the task's output.
- <p/>
- The key functionality of this feature is that the Mappers in the chain do not
- need to be aware that they are executed after the Reducer or in a chain.
- This enables having reusable specialized Mappers that can be combined to
- perform composite operations within a single task.
- <p/>
- Special care has to be taken when creating chains that the key/values output
- by a Mapper are valid for the following Mapper in the chain. It is assumed
- all Mappers and the Reduce in the chain use maching output and input key and
- value classes as no conversion is done by the chaining code.
- <p/>
- Using the ChainMapper and the ChainReducer classes is possible to compose
- Map/Reduce jobs that look like <code>[MAP+ / REDUCE MAP*]</code>. And
- immediate benefit of this pattern is a dramatic reduction in disk IO.
- <p/>
- IMPORTANT: There is no need to specify the output key/value classes for the
- ChainReducer, this is done by the setReducer or the addMapper for the last
- element in the chain.
- <p/>
- ChainReducer usage pattern:
- <p/>
- <pre>
- ...
- conf.setJobName("chain");
- conf.setInputFormat(TextInputFormat.class);
- conf.setOutputFormat(TextOutputFormat.class);
- <p/>
- JobConf mapAConf = new JobConf(false);
- ...
- ChainMapper.addMapper(conf, AMap.class, LongWritable.class, Text.class,
- Text.class, Text.class, true, mapAConf);
- <p/>
- JobConf mapBConf = new JobConf(false);
- ...
- ChainMapper.addMapper(conf, BMap.class, Text.class, Text.class,
- LongWritable.class, Text.class, false, mapBConf);
- <p/>
- JobConf reduceConf = new JobConf(false);
- ...
- ChainReducer.setReducer(conf, XReduce.class, LongWritable.class, Text.class,
- Text.class, Text.class, true, reduceConf);
- <p/>
- ChainReducer.addMapper(conf, CMap.class, Text.class, Text.class,
- LongWritable.class, Text.class, false, null);
- <p/>
- ChainReducer.addMapper(conf, DMap.class, LongWritable.class, Text.class,
- LongWritable.class, LongWritable.class, true, null);
- <p/>
- FileInputFormat.setInputPaths(conf, inDir);
- FileOutputFormat.setOutputPath(conf, outDir);
- ...
- <p/>
- JobClient jc = new JobClient(conf);
- RunningJob job = jc.submitJob(conf);
- ...
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.ChainReducer -->
- <!-- start class org.apache.hadoop.mapred.lib.CombineFileInputFormat -->
- <class name="CombineFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CombineFileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor]]>
- </doc>
- </constructor>
- <method name="setMaxSplitSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="maxSplitSize" type="long"/>
- <doc>
- <![CDATA[Specify the maximum size (in bytes) of each split. Each split is
- approximately equal to the specified size.]]>
- </doc>
- </method>
- <method name="setMinSplitSizeNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="minSplitSizeNode" type="long"/>
- <doc>
- <![CDATA[Specify the minimum size (in bytes) of each split per node.
- This applies to data that is left over after combining data on a single
- node into splits that are of maximum size specified by maxSplitSize.
- This leftover data will be combined into its own split if its size
- exceeds minSplitSizeNode.]]>
- </doc>
- </method>
- <method name="setMinSplitSizeRack"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="minSplitSizeRack" type="long"/>
- <doc>
- <![CDATA[Specify the minimum size (in bytes) of each split per rack.
- This applies to data that is left over after combining data on a single
- rack into splits that are of maximum size specified by maxSplitSize.
- This leftover data will be combined into its own split if its size
- exceeds minSplitSizeRack.]]>
- </doc>
- </method>
- <method name="createPool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="filters" type="java.util.List"/>
- <doc>
- <![CDATA[Create a new pool and add the filters to it.
- A split cannot have files from different pools.]]>
- </doc>
- </method>
- <method name="createPool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="filters" type="org.apache.hadoop.fs.PathFilter[]"/>
- <doc>
- <![CDATA[Create a new pool and add the filters to it.
- A pathname can satisfy any one of the specified filters.
- A split cannot have files from different pools.]]>
- </doc>
- </method>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This is not implemented yet.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An abstract {@link org.apache.hadoop.mapred.InputFormat} that returns {@link CombineFileSplit}'s
- in {@link org.apache.hadoop.mapred.InputFormat#getSplits(JobConf, int)} method.
- Splits are constructed from the files under the input paths.
- A split cannot have files from different pools.
- Each split returned may contain blocks from different files.
- If a maxSplitSize is specified, then blocks on the same node are
- combined to form a single split. Blocks that are left over are
- then combined with other blocks in the same rack.
- If maxSplitSize is not specified, then blocks from the same rack
- are combined in a single split; no attempt is made to create
- node-local splits.
- If the maxSplitSize is equal to the block size, then this class
- is similar to the default spliting behaviour in Hadoop: each
- block is a locally processed split.
- Subclasses implement {@link org.apache.hadoop.mapred.InputFormat#getRecordReader(InputSplit, JobConf, Reporter)}
- to construct <code>RecordReader</code>'s for <code>CombineFileSplit</code>'s.
- @see CombineFileSplit]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.CombineFileInputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.CombineFileRecordReader -->
- <class name="CombineFileRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="CombineFileRecordReader" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.mapred.lib.CombineFileSplit, org.apache.hadoop.mapred.Reporter, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A generic RecordReader that can hand out different recordReaders
- for each chunk in the CombineFileSplit.]]>
- </doc>
- </constructor>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[return the amount of data processed]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[return progress based on the amount of data processed so far.]]>
- </doc>
- </method>
- <method name="initNextRecordReader" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the record reader for the next chunk in this CombineFileSplit.]]>
- </doc>
- </method>
- <field name="split" type="org.apache.hadoop.mapred.lib.CombineFileSplit"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="jc" type="org.apache.hadoop.mapred.JobConf"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="reporter" type="org.apache.hadoop.mapred.Reporter"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rrClass" type="java.lang.Class"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rrConstructor" type="java.lang.reflect.Constructor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="fs" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="idx" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="progress" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="curReader" type="org.apache.hadoop.mapred.RecordReader"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A generic RecordReader that can hand out different recordReaders
- for each chunk in a {@link CombineFileSplit}.
- A CombineFileSplit can combine data chunks from multiple files.
- This class allows using different RecordReaders for processing
- these data chunks from different files.
- @see CombineFileSplit]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.CombineFileRecordReader -->
- <!-- start class org.apache.hadoop.mapred.lib.CombineFileSplit -->
- <class name="CombineFileSplit" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputSplit"/>
- <constructor name="CombineFileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor]]>
- </doc>
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[], long[], java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.lib.CombineFileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy constructor]]>
- </doc>
- </constructor>
- <method name="getJob" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartOffsets" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an array containing the startoffsets of the files in the split]]>
- </doc>
- </method>
- <method name="getLengths" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an array containing the lengths of the files in the split]]>
- </doc>
- </method>
- <method name="getOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the start offset of the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the length of the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getNumPaths" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of Paths in the split]]>
- </doc>
- </method>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns all the Paths in the split]]>
- </doc>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns all the Paths where this input-split resides]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A sub-collection of input files. Unlike {@link org.apache.hadoop.mapred.FileSplit},
- CombineFileSplit * class does not represent a split of a file, but a split of input files
- into smaller sets. A split may contain blocks from different file but all
- the blocks in the same split are probably local to some rack <br>
- CombineFileSplit can be used to implement {@link org.apache.hadoop.mapred.RecordReader}'s,
- with reading one record per file.
- @see org.apache.hadoop.mapred.FileSplit
- @see CombineFileInputFormat]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.CombineFileSplit -->
- <!-- start class org.apache.hadoop.mapred.lib.DelegatingInputFormat -->
- <class name="DelegatingInputFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputFormat"/>
- <constructor name="DelegatingInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} that delegates behaviour of paths to multiple other
- InputFormats.
-
- @see MultipleInputs#addInputPath(JobConf, Path, Class, Class)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.DelegatingInputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.DelegatingMapper -->
- <class name="DelegatingMapper" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="DelegatingMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="outputCollector" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link Mapper} that delegates behaviour of paths to multiple other
- mappers.
-
- @see MultipleInputs#addInputPath(JobConf, Path, Class, Class)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.DelegatingMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.FieldSelectionMapReduce -->
- <class name="FieldSelectionMapReduce" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <implements name="org.apache.hadoop.mapred.Reducer"/>
- <constructor name="FieldSelectionMapReduce"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The identify function. Input key/value pair is written directly to output.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class implements a mapper/reducer class that can be used to perform
- field selections in a manner similar to unix cut. The input data is treated
- as fields separated by a user specified separator (the default value is
- "\t"). The user can specify a list of fields that form the map output keys,
- and a list of fields that form the map output values. If the inputformat is
- TextInputFormat, the mapper will ignore the key to the map function. and the
- fields are from the value only. Otherwise, the fields are the union of those
- from the key and those from the value.
-
- The field separator is under attribute "mapred.data.field.separator"
-
- The map output field list spec is under attribute "map.output.key.value.fields.spec".
- The value is expected to be like "keyFieldsSpec:valueFieldsSpec"
- key/valueFieldsSpec are comma (,) separated field spec: fieldSpec,fieldSpec,fieldSpec ...
- Each field spec can be a simple number (e.g. 5) specifying a specific field, or a range
- (like 2-5) to specify a range of fields, or an open range (like 3-) specifying all
- the fields starting from field 3. The open range field spec applies value fields only.
- They have no effect on the key fields.
-
- Here is an example: "4,3,0,1:6,5,1-3,7-". It specifies to use fields 4,3,0 and 1 for keys,
- and use fields 6,5,1,2,3,7 and above for values.
-
- The reduce output field list spec is under attribute "reduce.output.key.value.fields.spec".
-
- The reducer extracts output key/value pairs in a similar manner, except that
- the key is never ignored.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.FieldSelectionMapReduce -->
- <!-- start class org.apache.hadoop.mapred.lib.HashPartitioner -->
- <class name="HashPartitioner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Partitioner"/>
- <constructor name="HashPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numReduceTasks" type="int"/>
- <doc>
- <![CDATA[Use {@link Object#hashCode()} to partition.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Partition keys by their {@link Object#hashCode()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.HashPartitioner -->
- <!-- start class org.apache.hadoop.mapred.lib.IdentityMapper -->
- <class name="IdentityMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="IdentityMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The identify function. Input key/value pair is written directly to
- output.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implements the identity function, mapping inputs directly to outputs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.IdentityMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.IdentityReducer -->
- <class name="IdentityReducer" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Reducer"/>
- <constructor name="IdentityReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Writes all keys and values directly to output.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Performs no reduction, writing all input values directly to the output.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.IdentityReducer -->
- <!-- start class org.apache.hadoop.mapred.lib.InputSampler -->
- <class name="InputSampler" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="InputSampler" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="writePartitionFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="sampler" type="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write a partition file for the given job, using the Sampler provided.
- Queries the sampler for a sample keyset, sorts by the output key
- comparator, selects the keys for each rank, and writes to the destination
- returned from {@link
- org.apache.hadoop.mapred.lib.TotalOrderPartitioner#getPartitionFile}.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Driver for InputSampler from the command line.
- Configures a JobConf instance and calls {@link #writePartitionFile}.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[Utility for collecting samples and writing a partition file for
- {@link org.apache.hadoop.mapred.lib.TotalOrderPartitioner}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.InputSampler -->
- <!-- start class org.apache.hadoop.mapred.lib.InputSampler.IntervalSampler -->
- <class name="InputSampler.IntervalSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
- <constructor name="InputSampler.IntervalSampler" type="double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new IntervalSampler sampling <em>all</em> splits.
- @param freq The frequency with which records will be emitted.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.IntervalSampler" type="double, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new IntervalSampler.
- @param freq The frequency with which records will be emitted.
- @param maxSplitsSampled The maximum number of splits to examine.
- @see #getSample]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For each split sampled, emit when the ratio of the number of records
- retained to the total record count is less than the specified
- frequency.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Sample from s splits at regular intervals.
- Useful for sorted data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.InputSampler.IntervalSampler -->
- <!-- start class org.apache.hadoop.mapred.lib.InputSampler.RandomSampler -->
- <class name="InputSampler.RandomSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
- <constructor name="InputSampler.RandomSampler" type="double, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new RandomSampler sampling <em>all</em> splits.
- This will read every split at the client, which is very expensive.
- @param freq Probability with which a key will be chosen.
- @param numSamples Total number of samples to obtain from all selected
- splits.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.RandomSampler" type="double, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new RandomSampler.
- @param freq Probability with which a key will be chosen.
- @param numSamples Total number of samples to obtain from all selected
- splits.
- @param maxSplitsSampled The maximum number of splits to examine.]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Randomize the split order, then take the specified number of keys from
- each split sampled, where each key is selected with the specified
- probability and possibly replaced by a subsequently selected key when
- the quota of keys from that split is satisfied.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Sample from random points in the input.
- General-purpose sampler. Takes numSamples / maxSplitsSampled inputs from
- each split.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.InputSampler.RandomSampler -->
- <!-- start interface org.apache.hadoop.mapred.lib.InputSampler.Sampler -->
- <interface name="InputSampler.Sampler" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For a given job, collect and return a subset of the keys from the
- input data.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface to sample using an {@link org.apache.hadoop.mapred.InputFormat}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.lib.InputSampler.Sampler -->
- <!-- start class org.apache.hadoop.mapred.lib.InputSampler.SplitSampler -->
- <class name="InputSampler.SplitSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
- <constructor name="InputSampler.SplitSampler" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a SplitSampler sampling <em>all</em> splits.
- Takes the first numSamples / numSplits records from each split.
- @param numSamples Total number of samples to obtain from all selected
- splits.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.SplitSampler" type="int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new SplitSampler.
- @param numSamples Total number of samples to obtain from all selected
- splits.
- @param maxSplitsSampled The maximum number of splits to examine.]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[From each split sampled, take the first numSamples / numSplits records.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Samples the first n records from s splits.
- Inexpensive way to sample random data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.InputSampler.SplitSampler -->
- <!-- start class org.apache.hadoop.mapred.lib.InverseMapper -->
- <class name="InverseMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="InverseMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The inverse function. Input keys and values are swapped.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link Mapper} that swaps keys and values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.InverseMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.KeyFieldBasedComparator -->
- <class name="KeyFieldBasedComparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="KeyFieldBasedComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[This comparator implementation provides a subset of the features provided
- by the Unix/GNU Sort. In particular, the supported features are:
- -n, (Sort numerically)
- -r, (Reverse the result of comparison)
- -k pos1[,pos2], where pos is of the form f[.c][opts], where f is the number
- of the field to use, and c is the number of the first character from the
- beginning of the field. Fields and character posns are numbered starting
- with 1; a character position of zero in pos2 indicates the field's last
- character. If '.c' is omitted from pos1, it defaults to 1 (the beginning
- of the field); if omitted from pos2, it defaults to 0 (the end of the
- field). opts are ordering options (any of 'nr' as described above).
- We assume that the fields in the key are separated by
- map.output.key.field.separator.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.KeyFieldBasedComparator -->
- <!-- start class org.apache.hadoop.mapred.lib.KeyFieldBasedPartitioner -->
- <class name="KeyFieldBasedPartitioner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Partitioner"/>
- <constructor name="KeyFieldBasedPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numReduceTasks" type="int"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="end" type="int"/>
- <param name="currentHash" type="int"/>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="hash" type="int"/>
- <param name="numReduceTasks" type="int"/>
- </method>
- <doc>
- <![CDATA[Defines a way to partition keys based on certain key fields (also see
- {@link KeyFieldBasedComparator}.
- The key specification supported is of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.KeyFieldBasedPartitioner -->
- <!-- start class org.apache.hadoop.mapred.lib.LongSumReducer -->
- <class name="LongSumReducer" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Reducer"/>
- <constructor name="LongSumReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link Reducer} that sums long values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.LongSumReducer -->
- <!-- start class org.apache.hadoop.mapred.lib.MultipleInputs -->
- <class name="MultipleInputs" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleInputs"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="inputFormatClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a {@link Path} with a custom {@link InputFormat} to the list of
- inputs for the map-reduce job.
-
- @param conf The configuration of the job
- @param path {@link Path} to be added to the list of inputs for the job
- @param inputFormatClass {@link InputFormat} class to use for this path]]>
- </doc>
- </method>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="inputFormatClass" type="java.lang.Class"/>
- <param name="mapperClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a {@link Path} with a custom {@link InputFormat} and
- {@link Mapper} to the list of inputs for the map-reduce job.
-
- @param conf The configuration of the job
- @param path {@link Path} to be added to the list of inputs for the job
- @param inputFormatClass {@link InputFormat} class to use for this path
- @param mapperClass {@link Mapper} class to use for this path]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class supports MapReduce jobs that have multiple input paths with
- a different {@link InputFormat} and {@link Mapper} for each path]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultipleInputs -->
- <!-- start class org.apache.hadoop.mapred.lib.MultipleOutputFormat -->
- <class name="MultipleOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a composite record writer that can write key/value data to different
- output files
-
- @param fs
- the file system to use
- @param job
- the job conf for the job
- @param name
- the leaf file name for the output file (such as part-00000")
- @param arg3
- a progressable for reporting progress.
- @return a composite record writer
- @throws IOException]]>
- </doc>
- </method>
- <method name="generateLeafFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate the leaf name for the output file name. The default behavior does
- not change the leaf file name (such as part-00000)
-
- @param name
- the leaf file name for the output file
- @return the given leaf file name]]>
- </doc>
- </method>
- <method name="generateFileNameForKeyValue" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate the file output file name based on the given key and the leaf file
- name. The default behavior is that the file name does not depend on the
- key.
-
- @param key
- the key of the output data
- @param name
- the leaf file name
- @return generated file name]]>
- </doc>
- </method>
- <method name="generateActualKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Generate the actual key from the given key/value. The default behavior is that
- the actual key is equal to the given key
-
- @param key
- the key of the output data
- @param value
- the value of the output data
- @return the actual key derived from the given key/value]]>
- </doc>
- </method>
- <method name="generateActualValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Generate the actual value from the given key and value. The default behavior is that
- the actual value is equal to the given value
-
- @param key
- the key of the output data
- @param value
- the value of the output data
- @return the actual value derived from the given key/value]]>
- </doc>
- </method>
- <method name="getInputFileBasedOutputFileName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate the outfile name based on a given anme and the input file name. If
- the map input file does not exists (i.e. this is not for a map only job),
- the given name is returned unchanged. If the config value for
- "num.of.trailing.legs.to.use" is not set, or set 0 or negative, the given
- name is returned unchanged. Otherwise, return a file name consisting of the
- N trailing legs of the input file name where N is the config value for
- "num.of.trailing.legs.to.use".
-
- @param job
- the job config
- @param name
- the output file name
- @return the outfile name based on a given anme and the input file name.]]>
- </doc>
- </method>
- <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@param fs
- the file system to use
- @param job
- a job conf object
- @param name
- the name of the file over which a record writer object will be
- constructed
- @param arg3
- a progressable object
- @return A RecordWriter object over the given file
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This abstract class extends the FileOutputFormat, allowing to write the
- output data to different output files. There are three basic use cases for
- this class.
-
- Case one: This class is used for a map reduce job with at least one reducer.
- The reducer wants to write data to different files depending on the actual
- keys. It is assumed that a key (or value) encodes the actual key (value)
- and the desired location for the actual key (value).
-
- Case two: This class is used for a map only job. The job wants to use an
- output file name that is either a part of the input file name of the input
- data, or some derivation of it.
-
- Case three: This class is used for a map only job. The job wants to use an
- output file name that depends on both the keys and the input file name,]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultipleOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.MultipleOutputs -->
- <class name="MultipleOutputs" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleOutputs" type="org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates and initializes multiple named outputs support, it should be
- instantiated in the Mapper/Reducer configure method.
- @param job the job configuration object]]>
- </doc>
- </constructor>
- <method name="getNamedOutputsList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Returns list of channel names.
- @param conf job conf
- @return List of channel Names]]>
- </doc>
- </method>
- <method name="isMultiNamedOutput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns if a named output is multiple.
- @param conf job conf
- @param namedOutput named output
- @return <code>true</code> if the name output is multi, <code>false</code>
- if it is single. If the name output is not defined it returns
- <code>false</code>]]>
- </doc>
- </method>
- <method name="getNamedOutputFormatClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the named output OutputFormat.
- @param conf job conf
- @param namedOutput named output
- @return namedOutput OutputFormat]]>
- </doc>
- </method>
- <method name="getNamedOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the key class for a named output.
- @param conf job conf
- @param namedOutput named output
- @return class for the named output key]]>
- </doc>
- </method>
- <method name="getNamedOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the value class for a named output.
- @param conf job conf
- @param namedOutput named output
- @return class of named output value]]>
- </doc>
- </method>
- <method name="addNamedOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <param name="outputFormatClass" type="java.lang.Class"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Adds a named output for the job.
- <p/>
- @param conf job conf to add the named output
- @param namedOutput named output name, it has to be a word, letters
- and numbers only, cannot be the word 'part' as
- that is reserved for the
- default output.
- @param outputFormatClass OutputFormat class.
- @param keyClass key class
- @param valueClass value class]]>
- </doc>
- </method>
- <method name="addMultiNamedOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="namedOutput" type="java.lang.String"/>
- <param name="outputFormatClass" type="java.lang.Class"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Adds a multi named output for the job.
- <p/>
- @param conf job conf to add the named output
- @param namedOutput named output name, it has to be a word, letters
- and numbers only, cannot be the word 'part' as
- that is reserved for the
- default output.
- @param outputFormatClass OutputFormat class.
- @param keyClass key class
- @param valueClass value class]]>
- </doc>
- </method>
- <method name="setCountersEnabled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="enabled" type="boolean"/>
- <doc>
- <![CDATA[Enables or disables counters for the named outputs.
- <p/>
- By default these counters are disabled.
- <p/>
- MultipleOutputs supports counters, by default the are disabled.
- The counters group is the {@link MultipleOutputs} class name.
- </p>
- The names of the counters are the same as the named outputs. For multi
- named outputs the name of the counter is the concatenation of the named
- output, and underscore '_' and the multiname.
- @param conf job conf to enableadd the named output.
- @param enabled indicates if the counters will be enabled or not.]]>
- </doc>
- </method>
- <method name="getCountersEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Returns if the counters for the named outputs are enabled or not.
- <p/>
- By default these counters are disabled.
- <p/>
- MultipleOutputs supports counters, by default the are disabled.
- The counters group is the {@link MultipleOutputs} class name.
- </p>
- The names of the counters are the same as the named outputs. For multi
- named outputs the name of the counter is the concatenation of the named
- output, and underscore '_' and the multiname.
- @param conf job conf to enableadd the named output.
- @return TRUE if the counters are enabled, FALSE if they are disabled.]]>
- </doc>
- </method>
- <method name="getNamedOutputs" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns iterator with the defined name outputs.
- @return iterator with the defined named outputs]]>
- </doc>
- </method>
- <method name="getCollector" return="org.apache.hadoop.mapred.OutputCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="namedOutput" type="java.lang.String"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the output collector for a named output.
- <p/>
- @param namedOutput the named output name
- @param reporter the reporter
- @return the output collector for the given named output
- @throws IOException thrown if output collector could not be created]]>
- </doc>
- </method>
- <method name="getCollector" return="org.apache.hadoop.mapred.OutputCollector"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="namedOutput" type="java.lang.String"/>
- <param name="multiName" type="java.lang.String"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the output collector for a multi named output.
- <p/>
- @param namedOutput the named output name
- @param multiName the multi name part
- @param reporter the reporter
- @return the output collector for the given named output
- @throws IOException thrown if output collector could not be created]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Closes all the opened named outputs.
- <p/>
- If overriden subclasses must invoke <code>super.close()</code> at the
- end of their <code>close()</code>
- @throws java.io.IOException thrown if any of the MultipleOutput files
- could not be closed properly.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MultipleOutputs class simplifies writting to additional outputs other
- than the job default output via the <code>OutputCollector</code> passed to
- the <code>map()</code> and <code>reduce()</code> methods of the
- <code>Mapper</code> and <code>Reducer</code> implementations.
- <p/>
- Each additional output, or named output, may be configured with its own
- <code>OutputFormat</code>, with its own key class and with its own value
- class.
- <p/>
- A named output can be a single file or a multi file. The later is refered as
- a multi named output.
- <p/>
- A multi named output is an unbound set of files all sharing the same
- <code>OutputFormat</code>, key class and value class configuration.
- <p/>
- When named outputs are used within a <code>Mapper</code> implementation,
- key/values written to a name output are not part of the reduce phase, only
- key/values written to the job <code>OutputCollector</code> are part of the
- reduce phase.
- <p/>
- MultipleOutputs supports counters, by default the are disabled. The counters
- group is the {@link MultipleOutputs} class name.
- </p>
- The names of the counters are the same as the named outputs. For multi
- named outputs the name of the counter is the concatenation of the named
- output, and underscore '_' and the multiname.
- <p/>
- Job configuration usage pattern is:
- <pre>
- JobConf conf = new JobConf();
- conf.setInputPath(inDir);
- FileOutputFormat.setOutputPath(conf, outDir);
- conf.setMapperClass(MOMap.class);
- conf.setReducerClass(MOReduce.class);
- ...
- // Defines additional single text based output 'text' for the job
- MultipleOutputs.addNamedOutput(conf, "text", TextOutputFormat.class,
- LongWritable.class, Text.class);
- // Defines additional multi sequencefile based output 'sequence' for the
- // job
- MultipleOutputs.addMultiNamedOutput(conf, "seq",
- SequenceFileOutputFormat.class,
- LongWritable.class, Text.class);
- ...
- JobClient jc = new JobClient();
- RunningJob job = jc.submitJob(conf);
- ...
- </pre>
- <p/>
- Job configuration usage pattern is:
- <pre>
- public class MOReduce implements
- Reducer<WritableComparable, Writable> {
- private MultipleOutputs mos;
- public void configure(JobConf conf) {
- ...
- mos = new MultipleOutputs(conf);
- }
- public void reduce(WritableComparable key, Iterator<Writable> values,
- OutputCollector output, Reporter reporter)
- throws IOException {
- ...
- mos.getCollector("text", reporter).collect(key, new Text("Hello"));
- mos.getCollector("seq", "A", reporter).collect(key, new Text("Bye"));
- mos.getCollector("seq", "B", reporter).collect(key, new Text("Chau"));
- ...
- }
- public void close() throws IOException {
- mos.close();
- ...
- }
- }
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultipleOutputs -->
- <!-- start class org.apache.hadoop.mapred.lib.MultipleSequenceFileOutputFormat -->
- <class name="MultipleSequenceFileOutputFormat" extends="org.apache.hadoop.mapred.lib.MultipleOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleSequenceFileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class extends the MultipleOutputFormat, allowing to write the output data
- to different output files in sequence file output format.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultipleSequenceFileOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.MultipleTextOutputFormat -->
- <class name="MultipleTextOutputFormat" extends="org.apache.hadoop.mapred.lib.MultipleOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleTextOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class extends the MultipleOutputFormat, allowing to write the output
- data to different output files in Text output format.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultipleTextOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.MultithreadedMapRunner -->
- <class name="MultithreadedMapRunner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.MapRunnable"/>
- <constructor name="MultithreadedMapRunner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Multithreaded implementation for @link org.apache.hadoop.mapred.MapRunnable.
- <p>
- It can be used instead of the default implementation,
- @link org.apache.hadoop.mapred.MapRunner, when the Map operation is not CPU
- bound in order to improve throughput.
- <p>
- Map implementations using this MapRunnable must be thread-safe.
- <p>
- The Map-Reduce job has to be configured to use this MapRunnable class (using
- the JobConf.setMapRunnerClass method) and
- the number of thread the thread-pool can use with the
- <code>mapred.map.multithreadedrunner.threads</code> property, its default
- value is 10 threads.
- <p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.MultithreadedMapRunner -->
- <!-- start class org.apache.hadoop.mapred.lib.NLineInputFormat -->
- <class name="NLineInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="NLineInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="numSplits" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Logically splits the set of input files for the job, splits N lines
- of the input as one split.
-
- @see org.apache.hadoop.mapred.FileInputFormat#getSplits(JobConf, int)]]>
- </doc>
- </method>
- <method name="createFileSplit" return="org.apache.hadoop.mapred.FileSplit"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fileName" type="org.apache.hadoop.fs.Path"/>
- <param name="begin" type="long"/>
- <param name="length" type="long"/>
- <doc>
- <![CDATA[NLineInputFormat uses LineRecordReader, which always reads
- (and consumes) at least one character out of its upper split
- boundary. So to make sure that each mapper gets N lines, we
- move back the upper split limits of each split
- by one character here.
- @param fileName Path of file
- @param begin the position of the first byte in the file to process
- @param length number of bytes in InputSplit
- @return FileSplit]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <doc>
- <![CDATA[NLineInputFormat which splits N lines of input as one split.
- In many "pleasantly" parallel applications, each process/mapper
- processes the same input file (s), but with computations are
- controlled by different parameters.(Referred to as "parameter sweeps").
- One way to achieve this, is to specify a set of parameters
- (one set per line) as input in a control file
- (which is the input path to the map-reduce application,
- where as the input dataset is specified
- via a config variable in JobConf.).
-
- The NLineInputFormat can be used in such applications, that splits
- the input file such that by default, one line is fed as
- a value to one map task, and key is the offset.
- i.e. (k,v) is (LongWritable, Text).
- The location hints will span the whole mapred cluster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.NLineInputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.NullOutputFormat -->
- <class name="NullOutputFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.OutputFormat"/>
- <constructor name="NullOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <doc>
- <![CDATA[Consume all outputs and put them in /dev/null.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.NullOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.RegexMapper -->
- <class name="RegexMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="RegexMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link Mapper} that extracts text matching a regular expression.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.RegexMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.TokenCountMapper -->
- <class name="TokenCountMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="TokenCountMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link Mapper} that maps text values into <token,freq> pairs. Uses
- {@link StringTokenizer} to break text into tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.TokenCountMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.TotalOrderPartitioner -->
- <class name="TotalOrderPartitioner" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Partitioner"/>
- <constructor name="TotalOrderPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Read in the partition file and build indexing data structures.
- If the keytype is {@link org.apache.hadoop.io.BinaryComparable} and
- <tt>total.order.partitioner.natural.order</tt> is not false, a trie
- of the first <tt>total.order.partitioner.max.trie.depth</tt>(2) + 1 bytes
- will be built. Otherwise, keys will be located using a binary search of
- the partition keyset using the {@link org.apache.hadoop.io.RawComparator}
- defined for this job. The input file must be sorted with the same
- comparator and contain {@link
- org.apache.hadoop.mapred.JobConf#getNumReduceTasks} - 1 keys.]]>
- </doc>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numPartitions" type="int"/>
- </method>
- <method name="setPartitionFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the path to the SequenceFile storing the sorted partition keyset.
- It must be the case that for <tt>R</tt> reduces, there are <tt>R-1</tt>
- keys in the SequenceFile.]]>
- </doc>
- </method>
- <method name="getPartitionFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the path to the SequenceFile storing the sorted partition keyset.
- @see #setPartitionFile(JobConf,Path)]]>
- </doc>
- </method>
- <field name="DEFAULT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Partitioner effecting a total order by reading split points from
- an externally generated source.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.TotalOrderPartitioner -->
- </package>
- <package name="org.apache.hadoop.mapred.lib.aggregate">
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.DoubleValueSum -->
- <class name="DoubleValueSum" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="DoubleValueSum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- an object whose string representation represents a double value.]]>
- </doc>
- </method>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="double"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- a double value.]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="getSum" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that sums up a sequence of double
- values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.DoubleValueSum -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueMax -->
- <class name="LongValueMax" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="LongValueMax"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- an object whose string representation represents a long value.]]>
- </doc>
- </method>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newVal" type="long"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param newVal
- a long value.]]>
- </doc>
- </method>
- <method name="getVal" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that maintain the maximum of
- a sequence of long values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueMax -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueMin -->
- <class name="LongValueMin" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="LongValueMin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- an object whose string representation represents a long value.]]>
- </doc>
- </method>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="newVal" type="long"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param newVal
- a long value.]]>
- </doc>
- </method>
- <method name="getVal" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that maintain the minimum of
- a sequence of long values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueMin -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueSum -->
- <class name="LongValueSum" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="LongValueSum"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- an object whose string representation represents a long value.]]>
- </doc>
- </method>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="long"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- a long value.]]>
- </doc>
- </method>
- <method name="getSum" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that sums up
- a sequence of long values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueSum -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.StringValueMax -->
- <class name="StringValueMax" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="StringValueMax"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- a string.]]>
- </doc>
- </method>
- <method name="getVal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that maintain the biggest of
- a sequence of strings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.StringValueMax -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.StringValueMin -->
- <class name="StringValueMin" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="StringValueMin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- a string.]]>
- </doc>
- </method>
- <method name="getVal" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the aggregated value]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the aggregated value]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of one element. The element is a string
- representation of the aggregated value. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that maintain the smallest of
- a sequence of strings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.StringValueMin -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.UniqValueCount -->
- <class name="UniqValueCount" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="UniqValueCount"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the default constructor]]>
- </doc>
- </constructor>
- <constructor name="UniqValueCount" type="long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructor
- @param maxNum the limit in the number of unique values to keep.]]>
- </doc>
- </constructor>
- <method name="setMaxItems" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="n" type="long"/>
- <doc>
- <![CDATA[Set the limit on the number of unique values
- @param n the desired limit on the number of unique values
- @return the new limit on the number of unique values]]>
- </doc>
- </method>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val
- an object.]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return the number of unique objects aggregated]]>
- </doc>
- </method>
- <method name="getUniqueItems" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the set of the unique objects]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return return an array of the unique objects. The return value is
- expected to be used by the a combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that dedupes a sequence of objects.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.UniqValueCount -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.UserDefinedValueAggregatorDescriptor -->
- <class name="UserDefinedValueAggregatorDescriptor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor"/>
- <constructor name="UserDefinedValueAggregatorDescriptor" type="java.lang.String, org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param className the class name of the user defined descriptor class
- @param job a configure object used for decriptor configuration]]>
- </doc>
- </constructor>
- <method name="createInstance" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="className" type="java.lang.String"/>
- <doc>
- <![CDATA[Create an instance of the given class
- @param className the name of the class
- @return a dynamically created instance of the given class]]>
- </doc>
- </method>
- <method name="generateKeyValPairs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[Generate a list of aggregation-id/value pairs for the given key/value pairs
- by delegating the invocation to the real object.
-
- @param key
- input key
- @param val
- input value
- @return a list of aggregation id/value pairs. An aggregation id encodes an
- aggregation type which is used to guide the way to aggregate the
- value in the reduce/combiner phrase of an Aggregate based job.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of this object.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Do nothing.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a wrapper for a user defined value aggregator descriptor.
- It servs two functions: One is to create an object of ValueAggregatorDescriptor from the
- name of a user defined class that may be dynamically loaded. The other is to
- deligate inviokations of generateKeyValPairs function to the created object.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.UserDefinedValueAggregatorDescriptor -->
- <!-- start interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregator -->
- <interface name="ValueAggregator" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add a value to the aggregator
-
- @param val the value to be added]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of the agregator]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return an array of values as the outputs of the combiner.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This interface defines the minimal protocol for value aggregators.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregator -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorBaseDescriptor -->
- <class name="ValueAggregatorBaseDescriptor" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor"/>
- <constructor name="ValueAggregatorBaseDescriptor"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="generateEntry" return="java.util.Map.Entry"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <param name="id" type="java.lang.String"/>
- <param name="val" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[@param type the aggregation type
- @param id the aggregation id
- @param val the val associated with the id to be aggregated
- @return an Entry whose key is the aggregation id prefixed with
- the aggregation type.]]>
- </doc>
- </method>
- <method name="generateValueAggregator" return="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <doc>
- <![CDATA[@param type the aggregation type
- @return a value aggregator of the given type.]]>
- </doc>
- </method>
- <method name="generateKeyValPairs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[Generate 1 or 2 aggregation-id/value pairs for the given key/value pair.
- The first id will be of type LONG_VALUE_SUM, with "record_count" as
- its aggregation id. If the input is a file split,
- the second id of the same type will be generated too, with the file name
- as its aggregation id. This achieves the behavior of counting the total number
- of records in the input data, and the number of records in each input file.
-
- @param key
- input key
- @param val
- input value
- @return a list of aggregation id/value pairs. An aggregation id encodes an
- aggregation type which is used to guide the way to aggregate the
- value in the reduce/combiner phrase of an Aggregate based job.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[get the input file name.
-
- @param job a job configuration object]]>
- </doc>
- </method>
- <field name="UNIQ_VALUE_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG_VALUE_SUM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DOUBLE_VALUE_SUM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VALUE_HISTOGRAM" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG_VALUE_MAX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LONG_VALUE_MIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STRING_VALUE_MAX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STRING_VALUE_MIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="inputFile" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class implements the common functionalities of
- the subclasses of ValueAggregatorDescriptor class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorBaseDescriptor -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorCombiner -->
- <class name="ValueAggregatorCombiner" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ValueAggregatorCombiner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Combiner does not need to configure.]]>
- </doc>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Combines values for a given key.
- @param key the key is expected to be a Text object, whose prefix indicates
- the type of aggregation to aggregate the values.
- @param values the values to combine
- @param output to collect combined values]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Do nothing.]]>
- </doc>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="arg1" type="org.apache.hadoop.io.Writable"/>
- <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Do nothing. Should not be called.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements the generic combiner of Aggregate.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorCombiner -->
- <!-- start interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor -->
- <interface name="ValueAggregatorDescriptor" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="generateKeyValPairs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[Generate a list of aggregation-id/value pairs for the given key/value pair.
- This function is usually called by the mapper of an Aggregate based job.
-
- @param key
- input key
- @param val
- input value
- @return a list of aggregation id/value pairs. An aggregation id encodes an
- aggregation type which is used to guide the way to aggregate the
- value in the reduce/combiner phrase of an Aggregate based job.]]>
- </doc>
- </method>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Configure the object
-
- @param job
- a JobConf object that may contain the information that can be used
- to configure the object.]]>
- </doc>
- </method>
- <field name="TYPE_SEPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ONE" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This interface defines the contract a value aggregator descriptor must
- support. Such a descriptor can be configured with a JobConf object. Its main
- function is to generate a list of aggregation-id/value pairs. An aggregation
- id encodes an aggregation type which is used to guide the way to aggregate
- the value in the reduce/combiner phrase of an Aggregate based job.The mapper in
- an Aggregate based map/reduce job may create one or more of
- ValueAggregatorDescriptor objects at configuration time. For each input
- key/value pair, the mapper will use those objects to create aggregation
- id/value pairs.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJob -->
- <class name="ValueAggregatorJob" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ValueAggregatorJob"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createValueAggregatorJobs" return="org.apache.hadoop.mapred.jobcontrol.JobControl"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <param name="descriptors" type="java.lang.Class[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createValueAggregatorJobs" return="org.apache.hadoop.mapred.jobcontrol.JobControl"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an Aggregate based map/reduce job.
- @param args the arguments used for job creation. Generic hadoop
- arguments are accepted.
- @return a JobConf object ready for submission.
- @throws IOException
- @see GenericOptionsParser]]>
- </doc>
- </method>
- <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <param name="caller" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create an Aggregate based map/reduce job.
-
- @param args the arguments used for job creation. Generic hadoop
- arguments are accepted.
- @param caller the the caller class.
- @return a JobConf object ready for submission.
-
- @throws IOException
- @see GenericOptionsParser]]>
- </doc>
- </method>
- <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <param name="descriptors" type="java.lang.Class[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <param name="descriptors" type="java.lang.Class[]"/>
- <param name="caller" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setAggregatorDescriptors"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="descriptors" type="java.lang.Class[]"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[create and run an Aggregate based map/reduce job.
-
- @param args the arguments used for job creation
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is the main class for creating a map/reduce job using Aggregate
- framework. The Aggregate is a specialization of map/reduce framework,
- specilizing for performing various simple aggregations.
-
- Generally speaking, in order to implement an application using Map/Reduce
- model, the developer is to implement Map and Reduce functions (and possibly
- combine function). However, a lot of applications related to counting and
- statistics computing have very similar characteristics. Aggregate abstracts
- out the general patterns of these functions and implementing those patterns.
- In particular, the package provides generic mapper/redducer/combiner classes,
- and a set of built-in value aggregators, and a generic utility class that
- helps user create map/reduce jobs using the generic class. The built-in
- aggregators include:
-
- sum over numeric values count the number of distinct values compute the
- histogram of values compute the minimum, maximum, media,average, standard
- deviation of numeric values
-
- The developer using Aggregate will need only to provide a plugin class
- conforming to the following interface:
-
- public interface ValueAggregatorDescriptor { public ArrayList<Entry>
- generateKeyValPairs(Object key, Object value); public void
- configure(JobConfjob); }
-
- The package also provides a base class, ValueAggregatorBaseDescriptor,
- implementing the above interface. The user can extend the base class and
- implement generateKeyValPairs accordingly.
-
- The primary work of generateKeyValPairs is to emit one or more key/value
- pairs based on the input key/value pair. The key in an output key/value pair
- encode two pieces of information: aggregation type and aggregation id. The
- value will be aggregated onto the aggregation id according the aggregation
- type.
-
- This class offers a function to generate a map/reduce job using Aggregate
- framework. The function takes the following parameters: input directory spec
- input format (text or sequence file) output directory a file specifying the
- user plugin class]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJob -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase -->
- <class name="ValueAggregatorJobBase" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <implements name="org.apache.hadoop.mapred.Reducer"/>
- <constructor name="ValueAggregatorJobBase"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="logSpec"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="aggregatorDescriptorList" type="java.util.ArrayList"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This abstract class implements some common functionalities of the
- the generic mapper, reducer and combiner classes of Aggregate.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorMapper -->
- <class name="ValueAggregatorMapper" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ValueAggregatorMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Writable"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[the map function. It iterates through the value aggregator descriptor
- list to generate aggregation id/value pairs and emit them.]]>
- </doc>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="org.apache.hadoop.io.Text"/>
- <param name="arg1" type="java.util.Iterator"/>
- <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Do nothing. Should not be called.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements the generic mapper of Aggregate.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorMapper -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorReducer -->
- <class name="ValueAggregatorReducer" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ValueAggregatorReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="values" type="java.util.Iterator"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@param key
- the key is expected to be a Text object, whose prefix indicates
- the type of aggregation to aggregate the values. In effect, data
- driven computing is achieved. It is assumed that each aggregator's
- getReport method emits appropriate output for the aggregator. This
- may be further customiized.
- @value the values to be aggregated]]>
- </doc>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="arg1" type="org.apache.hadoop.io.Writable"/>
- <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Do nothing. Should not be called]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements the generic reducer of Aggregate.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorReducer -->
- <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueHistogram -->
- <class name="ValueHistogram" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
- <constructor name="ValueHistogram"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addNextValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="val" type="java.lang.Object"/>
- <doc>
- <![CDATA[add the given val to the aggregator.
-
- @param val the value to be added. It is expected to be a string
- in the form of xxxx\tnum, meaning xxxx has num occurrences.]]>
- </doc>
- </method>
- <method name="getReport" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the string representation of this aggregator.
- It includes the following basic statistics of the histogram:
- the number of unique values
- the minimum value
- the media value
- the maximum value
- the average value
- the standard deviation]]>
- </doc>
- </method>
- <method name="getReportDetails" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a string representation of the list of value/frequence pairs of
- the histogram]]>
- </doc>
- </method>
- <method name="getCombinerOutput" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a list value/frequence pairs.
- The return value is expected to be used by the reducer.]]>
- </doc>
- </method>
- <method name="getReportItems" return="java.util.TreeMap"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a TreeMap representation of the histogram]]>
- </doc>
- </method>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[reset the aggregator]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class implements a value aggregator that computes the
- histogram of a sequence of strings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueHistogram -->
- </package>
- <package name="org.apache.hadoop.mapred.lib.db">
- <!-- start class org.apache.hadoop.mapred.lib.db.DBConfiguration -->
- <class name="DBConfiguration" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="configureDB"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="driverClass" type="java.lang.String"/>
- <param name="dbUrl" type="java.lang.String"/>
- <param name="userName" type="java.lang.String"/>
- <param name="passwd" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the DB access related fields in the JobConf.
- @param job the job
- @param driverClass JDBC Driver class name
- @param dbUrl JDBC DB access URL.
- @param userName DB access username
- @param passwd DB access passwd]]>
- </doc>
- </method>
- <method name="configureDB"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="driverClass" type="java.lang.String"/>
- <param name="dbUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the DB access related fields in the JobConf.
- @param job the job
- @param driverClass JDBC Driver class name
- @param dbUrl JDBC DB access URL.]]>
- </doc>
- </method>
- <field name="DRIVER_CLASS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The JDBC Driver class name]]>
- </doc>
- </field>
- <field name="URL_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[JDBC Database access URL]]>
- </doc>
- </field>
- <field name="USERNAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[User name to access the database]]>
- </doc>
- </field>
- <field name="PASSWORD_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Password to access the database]]>
- </doc>
- </field>
- <field name="INPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Input table name]]>
- </doc>
- </field>
- <field name="INPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Field names in the Input table]]>
- </doc>
- </field>
- <field name="INPUT_CONDITIONS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[WHERE clause in the input SELECT statement]]>
- </doc>
- </field>
- <field name="INPUT_ORDER_BY_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ORDER BY clause in the input SELECT statement]]>
- </doc>
- </field>
- <field name="INPUT_QUERY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whole input query, exluding LIMIT...OFFSET]]>
- </doc>
- </field>
- <field name="INPUT_COUNT_QUERY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Input query to get the count of records]]>
- </doc>
- </field>
- <field name="INPUT_CLASS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class name implementing DBWritable which will hold input tuples]]>
- </doc>
- </field>
- <field name="OUTPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Output table name]]>
- </doc>
- </field>
- <field name="OUTPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Field names in the Output table]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A container for configuration property names for jobs with DB input/output.
- <br>
- The job can be configured using the static methods in this class,
- {@link DBInputFormat}, and {@link DBOutputFormat}.
- <p>
- Alternatively, the properties can be set in the configuration with proper
- values.
-
- @see DBConfiguration#configureDB(JobConf, String, String, String, String)
- @see DBInputFormat#setInput(JobConf, Class, String, String)
- @see DBInputFormat#setInput(JobConf, Class, String, String, String, String...)
- @see DBOutputFormat#setOutput(JobConf, String, String...)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBConfiguration -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat -->
- <class name="DBInputFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputFormat"/>
- <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
- <constructor name="DBInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="chunks" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCountQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for getting the total number of rows,
- subclasses can override this for custom behaviour.]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="conditions" type="java.lang.String"/>
- <param name="orderBy" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Initializes the map-part of the job with the appropriate input settings.
-
- @param job The job
- @param inputClass the class object implementing DBWritable, which is the
- Java object holding tuple fields.
- @param tableName The table to read data from
- @param conditions The condition which to select data with, eg. '(updated >
- 20070101 AND length > 0)'
- @param orderBy the fieldNames in the orderBy clause.
- @param fieldNames The field names in the table
- @see #setInput(JobConf, Class, String, String)]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="inputQuery" type="java.lang.String"/>
- <param name="inputCountQuery" type="java.lang.String"/>
- <doc>
- <![CDATA[Initializes the map-part of the job with the appropriate input settings.
-
- @param job The job
- @param inputClass the class object implementing DBWritable, which is the
- Java object holding tuple fields.
- @param inputQuery the input query to select fields. Example :
- "SELECT f1, f2, f3 FROM Mytable ORDER BY f1"
- @param inputCountQuery the input query that returns the number of records in
- the table.
- Example : "SELECT COUNT(f1) FROM Mytable"
- @see #setInput(JobConf, Class, String, String, String, String...)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A InputFormat that reads input data from an SQL table.
- <p>
- DBInputFormat emits LongWritables containing the record number as
- key and DBWritables as value.
-
- The SQL query, and input class can be using one of the two
- setInput methods.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit -->
- <class name="DBInputFormat.DBInputSplit" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.InputSplit"/>
- <constructor name="DBInputFormat.DBInputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default Constructor]]>
- </doc>
- </constructor>
- <constructor name="DBInputFormat.DBInputSplit" type="long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convenience Constructor
- @param start the index of the first row to select
- @param end the index of the last row to select]]>
- </doc>
- </constructor>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The index of the first row to select]]>
- </doc>
- </method>
- <method name="getEnd" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The index of the last row to select]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return The total row count in this split]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="output" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A InputSplit that spans a set of rows]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBRecordReader -->
- <class name="DBInputFormat.DBRecordReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordReader"/>
- <constructor name="DBInputFormat.DBRecordReader" type="org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.mapred.JobConf"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[@param split The InputSplit to read data for
- @throws SQLException]]>
- </doc>
- </constructor>
- <method name="getSelectQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for selecting the records,
- subclasses can override this for custom behaviour.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createKey" return="org.apache.hadoop.io.LongWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createValue" return="org.apache.hadoop.mapred.lib.db.DBWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.LongWritable"/>
- <param name="value" type="org.apache.hadoop.mapred.lib.db.DBWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A RecordReader that reads records from a SQL table.
- Emits LongWritables containing the record number as
- key and DBWritables as value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBRecordReader -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.NullDBWritable -->
- <class name="DBInputFormat.NullDBWritable" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.lib.db.DBWritable"/>
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="DBInputFormat.NullDBWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="java.sql.ResultSet"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="java.sql.PreparedStatement"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[A Class that does nothing, implementing DBWritable]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.NullDBWritable -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBOutputFormat -->
- <class name="DBOutputFormat" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.OutputFormat"/>
- <constructor name="DBOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="constructQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="table" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Constructs the query used as the prepared statement to insert data.
-
- @param table
- the table to insert into
- @param fieldNames
- the fields to insert into. If field names are unknown, supply an
- array of nulls.]]>
- </doc>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filesystem" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="filesystem" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="name" type="java.lang.String"/>
- <param name="progress" type="org.apache.hadoop.util.Progressable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Initializes the reduce-part of the job with the appropriate output settings
-
- @param job
- The job
- @param tableName
- The table to insert data into
- @param fieldNames
- The field names in the table. If unknown, supply the appropriate
- number of nulls.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A OutputFormat that sends the reduce output to a SQL table.
- <p>
- {@link DBOutputFormat} accepts <key,value> pairs, where
- key has a type extending DBWritable. Returned {@link RecordWriter}
- writes <b>only the key</b> to the database with a batch SQL query.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBOutputFormat -->
- <!-- start class org.apache.hadoop.mapred.lib.db.DBOutputFormat.DBRecordWriter -->
- <class name="DBOutputFormat.DBRecordWriter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.RecordWriter"/>
- <constructor name="DBOutputFormat.DBRecordWriter" type="java.sql.Connection, java.sql.PreparedStatement"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.mapred.lib.db.DBWritable"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A RecordWriter that writes the reduce output to a SQL table]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.lib.db.DBOutputFormat.DBRecordWriter -->
- <!-- start interface org.apache.hadoop.mapred.lib.db.DBWritable -->
- <interface name="DBWritable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="statement" type="java.sql.PreparedStatement"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Sets the fields of the object in the {@link PreparedStatement}.
- @param statement the statement that the fields are put into.
- @throws SQLException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resultSet" type="java.sql.ResultSet"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Reads the fields of the object from the {@link ResultSet}.
- @param resultSet the {@link ResultSet} to get the fields from.
- @throws SQLException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Objects that are read from/written to a database should implement
- <code>DBWritable</code>. DBWritable, is similar to {@link Writable}
- except that the {@link #write(PreparedStatement)} method takes a
- {@link PreparedStatement}, and {@link #readFields(ResultSet)}
- takes a {@link ResultSet}.
- <p>
- Implementations are responsible for writing the fields of the object
- to PreparedStatement, and reading the fields of the object from the
- ResultSet.
-
- <p>Example:</p>
- If we have the following table in the database :
- <pre>
- CREATE TABLE MyTable (
- counter INTEGER NOT NULL,
- timestamp BIGINT NOT NULL,
- );
- </pre>
- then we can read/write the tuples from/to the table with :
- <p><pre>
- public class MyWritable implements Writable, DBWritable {
- // Some data
- private int counter;
- private long timestamp;
-
- //Writable#write() implementation
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- //Writable#readFields() implementation
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public void write(PreparedStatement statement) throws SQLException {
- statement.setInt(1, counter);
- statement.setLong(2, timestamp);
- }
-
- public void readFields(ResultSet resultSet) throws SQLException {
- counter = resultSet.getInt(1);
- timestamp = resultSet.getLong(2);
- }
- }
- </pre></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapred.lib.db.DBWritable -->
- </package>
- <package name="org.apache.hadoop.mapred.pipes">
- <!-- start class org.apache.hadoop.mapred.pipes.Submitter -->
- <class name="Submitter" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="Submitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Submitter" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getExecutable" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Get the URI of the application's executable.
- @param conf
- @return the URI where the application's executable is located]]>
- </doc>
- </method>
- <method name="setExecutable"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="executable" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the URI for the application's executable. Normally this is a hdfs:
- location.
- @param conf
- @param executable The URI of the application's executable.]]>
- </doc>
- </method>
- <method name="setIsJavaRecordReader"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set whether the job is using a Java RecordReader.
- @param conf the configuration to modify
- @param value the new value]]>
- </doc>
- </method>
- <method name="getIsJavaRecordReader" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Check whether the job is using a Java RecordReader
- @param conf the configuration to check
- @return is it a Java RecordReader?]]>
- </doc>
- </method>
- <method name="setIsJavaMapper"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set whether the Mapper is written in Java.
- @param conf the configuration to modify
- @param value the new value]]>
- </doc>
- </method>
- <method name="getIsJavaMapper" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Check whether the job is using a Java Mapper.
- @param conf the configuration to check
- @return is it a Java Mapper?]]>
- </doc>
- </method>
- <method name="setIsJavaReducer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set whether the Reducer is written in Java.
- @param conf the configuration to modify
- @param value the new value]]>
- </doc>
- </method>
- <method name="getIsJavaReducer" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Check whether the job is using a Java Reducer.
- @param conf the configuration to check
- @return is it a Java Reducer?]]>
- </doc>
- </method>
- <method name="setIsJavaRecordWriter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Set whether the job will use a Java RecordWriter.
- @param conf the configuration to modify
- @param value the new value to set]]>
- </doc>
- </method>
- <method name="getIsJavaRecordWriter" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Will the reduce use a Java RecordWriter?
- @param conf the configuration to check
- @return true, if the output of the job will be written by Java]]>
- </doc>
- </method>
- <method name="getKeepCommandFile" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <doc>
- <![CDATA[Does the user want to keep the command file for debugging? If this is
- true, pipes will write a copy of the command data to a file in the
- task directory named "downlink.data", which may be used to run the C++
- program under the debugger. You probably also want to set
- JobConf.setKeepFailedTaskFiles(true) to keep the entire directory from
- being deleted.
- To run using the data file, set the environment variable
- "hadoop.pipes.command.file" to point to the file.
- @param conf the configuration to check
- @return will the framework save the command file?]]>
- </doc>
- </method>
- <method name="setKeepCommandFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <param name="keep" type="boolean"/>
- <doc>
- <![CDATA[Set whether to keep the command file for debugging
- @param conf the configuration to modify
- @param keep the new value]]>
- </doc>
- </method>
- <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="Use {@link Submitter#runJob(JobConf)}">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Submit a job to the map/reduce cluster. All of the necessary modifications
- to the job to run under pipes are made to the configuration.
- @param conf the job to submit to the cluster (MODIFIED)
- @throws IOException
- @deprecated Use {@link Submitter#runJob(JobConf)}]]>
- </doc>
- </method>
- <method name="runJob" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Submit a job to the map/reduce cluster. All of the necessary modifications
- to the job to run under pipes are made to the configuration.
- @param conf the job to submit to the cluster (MODIFIED)
- @throws IOException]]>
- </doc>
- </method>
- <method name="jobSubmit" return="org.apache.hadoop.mapred.RunningJob"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Submit a job to the Map-Reduce framework.
- This returns a handle to the {@link RunningJob} which can be used to track
- the running-job.
-
- @param conf the job configuration.
- @return a handle to the {@link RunningJob} which can be used to track the
- running-job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Submit a pipes job based on the command line arguments.
- @param args]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The main entry point and job submitter. It may either be used as a command
- line-based or API-based method to launch Pipes jobs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.pipes.Submitter -->
- </package>
- <package name="org.apache.hadoop.mapred.tools">
- <!-- start class org.apache.hadoop.mapred.tools.MRAdmin -->
- <class name="MRAdmin" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="MRAdmin"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="MRAdmin" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="refreshSuperUserGroupsConfiguration" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[refreshSuperUserGroupsConfiguration {@link JobTracker}.
- @return exitcode 0 on success, non-zero on failure
- @throws IOException]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[Administrative access to Hadoop Map-Reduce.
-
- Currently it only provides the ability to connect to the {@link JobTracker}
- and 1) refresh the service-level authorization policy, 2) refresh queue acl
- properties.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapred.tools.MRAdmin -->
- </package>
- <package name="org.apache.hadoop.mapreduce">
- <!-- start class org.apache.hadoop.mapreduce.ClusterMetrics -->
- <class name="ClusterMetrics" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="ClusterMetrics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ClusterMetrics" type="int, int, int, int, int, int, int, int, int, int, int, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRunningMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of running map tasks in the cluster.
-
- @return running maps]]>
- </doc>
- </method>
- <method name="getRunningReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of running reduce tasks in the cluster.
-
- @return running reduces]]>
- </doc>
- </method>
- <method name="getOccupiedMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get number of occupied map slots in the cluster.
-
- @return occupied map slot count]]>
- </doc>
- </method>
- <method name="getOccupiedReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of occupied reduce slots in the cluster.
-
- @return occupied reduce slot count]]>
- </doc>
- </method>
- <method name="getReservedMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get number of reserved map slots in the cluster.
-
- @return reserved map slot count]]>
- </doc>
- </method>
- <method name="getReservedReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of reserved reduce slots in the cluster.
-
- @return reserved reduce slot count]]>
- </doc>
- </method>
- <method name="getMapSlotCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of map slots in the cluster.
-
- @return map slot capacity]]>
- </doc>
- </method>
- <method name="getReduceSlotCapacity" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of reduce slots in the cluster.
-
- @return reduce slot capacity]]>
- </doc>
- </method>
- <method name="getTotalJobSubmissions" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of job submissions in the cluster.
-
- @return total number of job submissions]]>
- </doc>
- </method>
- <method name="getTaskTrackerCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of active trackers in the cluster.
-
- @return active tracker count.]]>
- </doc>
- </method>
- <method name="getBlackListedTaskTrackerCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of blacklisted trackers in the cluster.
-
- @return blacklisted tracker count]]>
- </doc>
- </method>
- <method name="getGrayListedTaskTrackerCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of graylisted trackers in the cluster.
-
- @return graylisted tracker count]]>
- </doc>
- </method>
- <method name="getDecommissionedTaskTrackerCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of decommissioned trackers in the cluster.
-
- @return decommissioned tracker count]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Status information on the current state of the Map-Reduce cluster.
-
- <p><code>ClusterMetrics</code> provides clients with information such as:
- <ol>
- <li>
- Size of the cluster.
- </li>
- <li>
- Number of blacklisted and decommissioned trackers.
- </li>
- <li>
- Slot capacity of the cluster.
- </li>
- <li>
- The number of currently occupied/reserved map & reduce slots.
- </li>
- <li>
- The number of currently running map & reduce tasks.
- </li>
- <li>
- The number of job submissions.
- </li>
- </ol></p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.ClusterMetrics -->
- <!-- start class org.apache.hadoop.mapreduce.Counter -->
- <class name="Counter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="Counter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Counter" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="setDisplayName"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="displayName" type="java.lang.String"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read the binary representation of the counter]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the binary representation of the counter]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDisplayName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the counter.
- @return the user facing name of the counter]]>
- </doc>
- </method>
- <method name="getValue" return="long"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[What is the current value of this counter?
- @return the current value]]>
- </doc>
- </method>
- <method name="setValue"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set this counter by the given value
- @param value the value to set]]>
- </doc>
- </method>
- <method name="increment"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="incr" type="long"/>
- <doc>
- <![CDATA[Increment this counter by the given value
- @param incr the value to increase this counter by]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericRight" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A named counter that tracks the progress of a map/reduce job.
-
- <p><code>Counters</code> represent global counters, defined either by the
- Map-Reduce framework or applications. Each <code>Counter</code> is named by
- an {@link Enum} and has a long for the value.</p>
-
- <p><code>Counters</code> are bunched into Groups, each comprising of
- counters from a particular <code>Enum</code> class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Counter -->
- <!-- start class org.apache.hadoop.mapreduce.CounterGroup -->
- <class name="CounterGroup" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Iterable"/>
- <constructor name="CounterGroup" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CounterGroup" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getResourceBundle" return="java.util.ResourceBundle"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="enumClassName" type="java.lang.String"/>
- <exception name="MissingResourceException" type="java.util.MissingResourceException"/>
- <doc>
- <![CDATA[Returns the specified resource bundle, or throws an exception.
- @throws MissingResourceException if the bundle isn't found]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the internal name of the group
- @return the internal name]]>
- </doc>
- </method>
- <method name="getDisplayName" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the display name of the group.
- @return the human readable name]]>
- </doc>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="counterName" type="java.lang.String"/>
- <param name="displayName" type="java.lang.String"/>
- <doc>
- <![CDATA[Internal to find a counter in a group.
- @param counterName the name of the counter
- @param displayName the display name of the counter
- @return the counter that was found or added]]>
- </doc>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counterName" type="java.lang.String"/>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of counters in this group.]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericRight" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incrAllCounters"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rightGroup" type="org.apache.hadoop.mapreduce.CounterGroup"/>
- </method>
- <doc>
- <![CDATA[A group of {@link Counter}s that logically belong together. Typically,
- it is an {@link Enum} subclass and the counters are the values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.CounterGroup -->
- <!-- start class org.apache.hadoop.mapreduce.Counters -->
- <class name="Counters" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="java.lang.Iterable"/>
- <constructor name="Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="Counters" type="org.apache.hadoop.mapred.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <param name="counterName" type="java.lang.String"/>
- </method>
- <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Enum"/>
- <doc>
- <![CDATA[Find the counter for the given enum. The same enum will always return the
- same counter.
- @param key the counter key
- @return the matching counter object]]>
- </doc>
- </method>
- <method name="getGroupNames" return="java.util.Collection"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the names of all counter classes.
- @return Set of counter names.]]>
- </doc>
- </method>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getGroup" return="org.apache.hadoop.mapreduce.CounterGroup"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <doc>
- <![CDATA[Returns the named counter group, or an empty group if there is none
- with the specified name.]]>
- </doc>
- </method>
- <method name="countCounters" return="int"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the total number of counters, by summing the number of counters
- in each group.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Write the set of groups.
- The external format is:
- #groups (groupName group)*
- i.e. the number of groups followed by 0 or more groups, where each
- group is of the form:
- groupDisplayName #counters (false | true counter)*
- where each counter is of the form:
- name (false | true displayName) value]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read a set of groups.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return textual representation of the counter values.]]>
- </doc>
- </method>
- <method name="incrAllCounters"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.mapreduce.Counters"/>
- <doc>
- <![CDATA[Increments multiple counters by their amounts in another Counters
- instance.
- @param other the other Counters instance]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericRight" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Counters -->
- <!-- start class org.apache.hadoop.mapreduce.ID -->
- <class name="ID" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.WritableComparable"/>
- <constructor name="ID" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[constructs an ID object from the given int]]>
- </doc>
- </constructor>
- <constructor name="ID"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[returns the int which represents the identifier]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="that" type="org.apache.hadoop.mapreduce.ID"/>
- <doc>
- <![CDATA[Compare IDs by associated numbers]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="SEPARATOR" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="id" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A general identifier, which internally stores the id
- as an integer. This is the super class of {@link JobID},
- {@link TaskID} and {@link TaskAttemptID}.
-
- @see JobID
- @see TaskID
- @see TaskAttemptID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.ID -->
- <!-- start class org.apache.hadoop.mapreduce.InputFormat -->
- <class name="InputFormat" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Logically split the set of input files for the job.
-
- <p>Each {@link InputSplit} is then assigned to an individual {@link Mapper}
- for processing.</p>
- <p><i>Note</i>: The split is a <i>logical</i> split of the inputs and the
- input files are not physically split into chunks. For e.g. a split could
- be <i><input-file-path, start, offset></i> tuple. The InputFormat
- also creates the {@link RecordReader} to read the {@link InputSplit}.
-
- @param context job configuration.
- @return an array of {@link InputSplit}s for the job.]]>
- </doc>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Create a record reader for a given split. The framework will call
- {@link RecordReader#initialize(InputSplit, TaskAttemptContext)} before
- the split is used.
- @param split the split to be read
- @param context the information about the task
- @return a new record reader
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>InputFormat</code> describes the input-specification for a
- Map-Reduce job.
-
- <p>The Map-Reduce framework relies on the <code>InputFormat</code> of the
- job to:<p>
- <ol>
- <li>
- Validate the input-specification of the job.
- <li>
- Split-up the input file(s) into logical {@link InputSplit}s, each of
- which is then assigned to an individual {@link Mapper}.
- </li>
- <li>
- Provide the {@link RecordReader} implementation to be used to glean
- input records from the logical <code>InputSplit</code> for processing by
- the {@link Mapper}.
- </li>
- </ol>
-
- <p>The default behavior of file-based {@link InputFormat}s, typically
- sub-classes of {@link FileInputFormat}, is to split the
- input into <i>logical</i> {@link InputSplit}s based on the total size, in
- bytes, of the input files. However, the {@link FileSystem} blocksize of
- the input files is treated as an upper bound for input splits. A lower bound
- on the split size can be set via
- <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
- mapred.min.split.size</a>.</p>
-
- <p>Clearly, logical splits based on input-size is insufficient for many
- applications since record boundaries are to respected. In such cases, the
- application has to also implement a {@link RecordReader} on whom lies the
- responsibility to respect record-boundaries and present a record-oriented
- view of the logical <code>InputSplit</code> to the individual task.
- @see InputSplit
- @see RecordReader
- @see FileInputFormat]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.InputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.InputSplit -->
- <class name="InputSplit" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLength" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the size of the split, so that the input splits can be sorted by size.
- @return the number of bytes in the split
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the list of nodes by name where the data for the split would be local.
- The locations do not need to be serialized.
- @return a new array of the node nodes.
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>InputSplit</code> represents the data to be processed by an
- individual {@link Mapper}.
- <p>Typically, it presents a byte-oriented view on the input and is the
- responsibility of {@link RecordReader} of the job to process this and present
- a record-oriented view.
-
- @see InputFormat
- @see RecordReader]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.InputSplit -->
- <!-- start class org.apache.hadoop.mapreduce.Job -->
- <class name="Job" extends="org.apache.hadoop.mapreduce.JobContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Job"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="Job" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="Job" type="org.apache.hadoop.conf.Configuration, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getInstance" return="org.apache.hadoop.mapreduce.Job"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a new {@link Job}
- A Job will be created with a generic {@link Configuration}.
- @return the {@link Job}
- @throws IOException]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.mapreduce.Job"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a new {@link Job} with a given {@link Configuration}.
- The <code>Job</code> makes a copy of the <code>Configuration</code> so
- that any necessary internal modifications do not reflect on the incoming
- parameter.
- @param conf the {@link Configuration}
- @return the {@link Job}
- @throws IOException]]>
- </doc>
- </method>
- <method name="getInstance" return="org.apache.hadoop.mapreduce.Job"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="jobName" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Creates a new {@link Job} with a given {@link Configuration}
- and a given jobName.
- The <code>Job</code> makes a copy of the <code>Configuration</code> so
- that any necessary internal modifications do not reflect on the incoming
- parameter.
- @param conf the {@link Configuration}
- @param jobName the job instance's name
- @return the {@link Job}
- @throws IOException]]>
- </doc>
- </method>
- <method name="setNumReduceTasks"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tasks" type="int"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the number of reduce tasks for the job.
- @param tasks the number of reduce tasks
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the current working directory for the default file system.
-
- @param dir the new current working directory.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setInputFormatClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the {@link InputFormat} for the job.
- @param cls the <code>InputFormat</code> to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setOutputFormatClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the {@link OutputFormat} for the job.
- @param cls the <code>OutputFormat</code> to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setMapperClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the {@link Mapper} for the job.
- @param cls the <code>Mapper</code> to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setJarByClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the Jar by finding where a given class came from.
- @param cls the example class]]>
- </doc>
- </method>
- <method name="getJar" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the pathname of the job's jar.
- @return the pathname]]>
- </doc>
- </method>
- <method name="setCombinerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the combiner class for the job.
- @param cls the combiner to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setReducerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the {@link Reducer} for the job.
- @param cls the <code>Reducer</code> to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setPartitionerClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the {@link Partitioner} for the job.
- @param cls the <code>Partitioner</code> to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setMapOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the key class for the map output data. This allows the user to
- specify the map output key class to be different than the final output
- value class.
-
- @param theClass the map output key class.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setMapOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the value class for the map output data. This allows the user to
- specify the map output value class to be different than the final output
- value class.
-
- @param theClass the map output value class.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the key class for the job output data.
-
- @param theClass the key class for the job output data.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="theClass" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the value class for job outputs.
-
- @param theClass the value class for job outputs.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setSortComparatorClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Define the comparator that controls how the keys are sorted before they
- are passed to the {@link Reducer}.
- @param cls the raw comparator
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setGroupingComparatorClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cls" type="java.lang.Class"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Define the comparator that controls which keys are grouped together
- for a single call to
- {@link Reducer#reduce(Object, Iterable,
- org.apache.hadoop.mapreduce.Reducer.Context)}
- @param cls the raw comparator to use
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setJobName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
- <doc>
- <![CDATA[Set the user-specified job name.
-
- @param name the job's new name.
- @throws IllegalStateException if the job is submitted]]>
- </doc>
- </method>
- <method name="setSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on, else <code>false</code>.]]>
- </doc>
- </method>
- <method name="setMapSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job for map tasks.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on for map tasks,
- else <code>false</code>.]]>
- </doc>
- </method>
- <method name="setReduceSpeculativeExecution"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="speculativeExecution" type="boolean"/>
- <doc>
- <![CDATA[Turn speculative execution on or off for this job for reduce tasks.
-
- @param speculativeExecution <code>true</code> if speculative execution
- should be turned on for reduce tasks,
- else <code>false</code>.]]>
- </doc>
- </method>
- <method name="getTrackingURL" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the URL where some job progress information will be displayed.
-
- @return the URL where some job progress information will be displayed.]]>
- </doc>
- </method>
- <method name="setupProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's setup, as a float between 0.0
- and 1.0. When the job setup is completed, the function returns 1.0.
-
- @return the progress of the job's setup.
- @throws IOException]]>
- </doc>
- </method>
- <method name="mapProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's map-tasks, as a float between 0.0
- and 1.0. When all map tasks have completed, the function returns 1.0.
-
- @return the progress of the job's map-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="reduceProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the <i>progress</i> of the job's reduce-tasks, as a float between 0.0
- and 1.0. When all reduce tasks have completed, the function returns 1.0.
-
- @return the progress of the job's reduce-tasks.
- @throws IOException]]>
- </doc>
- </method>
- <method name="isComplete" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if the job is finished or not.
- This is a non-blocking call.
-
- @return <code>true</code> if the job is complete, else <code>false</code>.
- @throws IOException]]>
- </doc>
- </method>
- <method name="isSuccessful" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check if the job completed successfully.
-
- @return <code>true</code> if the job succeeded, else <code>false</code>.
- @throws IOException]]>
- </doc>
- </method>
- <method name="killJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Kill the running job. Blocks until all job tasks have been
- killed as well. If the job is no longer running, it simply returns.
-
- @throws IOException]]>
- </doc>
- </method>
- <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startFrom" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get events indicating completion (success/failure) of component tasks.
-
- @param startFrom index to start fetching events from
- @return an array of {@link TaskCompletionEvent}s
- @throws IOException]]>
- </doc>
- </method>
- <method name="killTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Kill indicated task attempt.
-
- @param taskId the id of the task to be terminated.
- @throws IOException]]>
- </doc>
- </method>
- <method name="failTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskId" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Fail indicated task attempt.
-
- @param taskId the id of the task to be terminated.
- @throws IOException]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.mapreduce.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Gets the counters for this job.
-
- @return the counters for this job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="setCancelDelegationTokenUponJobCompletion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[Sets the flag that will allow the JobTracker to cancel the HDFS delegation
- tokens upon job completion. Defaults to true.]]>
- </doc>
- </method>
- <method name="submit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Submit the job to the cluster and return immediately.
- @throws IOException]]>
- </doc>
- </method>
- <method name="waitForCompletion" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="verbose" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Submit the job to the cluster and wait for it to finish.
- @param verbose print the progress to the user
- @return true if the job succeeded
- @throws IOException thrown if the communication with the
- <code>JobTracker</code> is lost]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The job submitter's view of the Job. It allows the user to configure the
- job, submit it, control its execution, and query the state. The set methods
- only work until the job is submitted, afterwards they will throw an
- IllegalStateException.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Job -->
- <!-- start class org.apache.hadoop.mapreduce.Job.JobState -->
- <class name="Job.JobState" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.Job.JobState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.Job.JobState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="DEFINE" type="org.apache.hadoop.mapreduce.Job.JobState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.mapreduce.Job.JobState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Job.JobState -->
- <!-- start class org.apache.hadoop.mapreduce.JobACL -->
- <class name="JobACL" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.JobACL[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.JobACL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getAclName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the ACL. Here it is same as the name of the configuration
- property for specifying the ACL for the job.
-
- @return aclName]]>
- </doc>
- </method>
- <field name="VIEW_JOB" type="org.apache.hadoop.mapreduce.JobACL"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL for 'viewing' job. Dictates who can 'view' some or all of the job
- related details.]]>
- </doc>
- </field>
- <field name="MODIFY_JOB" type="org.apache.hadoop.mapreduce.JobACL"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL for 'modifying' job. Dictates who can 'modify' the job for e.g., by
- killing the job, killing/failing a task of the job or setting priority of
- the job.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Job related ACLs]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobACL -->
- <!-- start class org.apache.hadoop.mapreduce.JobContext -->
- <class name="JobContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.JobID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConfiguration" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the configuration for the job.
- @return the shared configuration object]]>
- </doc>
- </method>
- <method name="getCredentials" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get credentials for the job.
- @return credentials for the job]]>
- </doc>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the unique ID for the job.
- @return the object with the job id]]>
- </doc>
- </method>
- <method name="getNumReduceTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get configured the number of reduce tasks for this job. Defaults to
- <code>1</code>.
- @return the number of reduce tasks for this job.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the current working directory for the default file system.
-
- @return the directory name.]]>
- </doc>
- </method>
- <method name="getOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the key class for the job output data.
- @return the key class for the job output data.]]>
- </doc>
- </method>
- <method name="getOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value class for job outputs.
- @return the value class for job outputs.]]>
- </doc>
- </method>
- <method name="getMapOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the key class for the map output data. If it is not set, use the
- (final) output key class. This allows the map output key class to be
- different than the final output key class.
- @return the map output key class.]]>
- </doc>
- </method>
- <method name="getMapOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the value class for the map output data. If it is not set, use the
- (final) output value class This allows the map output value class to be
- different than the final output value class.
-
- @return the map output value class.]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-specified job name. This is only used to identify the
- job to the user.
-
- @return the job's name, defaulting to "".]]>
- </doc>
- </method>
- <method name="getInputFormatClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the {@link InputFormat} class for the job.
-
- @return the {@link InputFormat} class for the job.]]>
- </doc>
- </method>
- <method name="getMapperClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the {@link Mapper} class for the job.
-
- @return the {@link Mapper} class for the job.]]>
- </doc>
- </method>
- <method name="getCombinerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the combiner class for the job.
-
- @return the combiner class for the job.]]>
- </doc>
- </method>
- <method name="getReducerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the {@link Reducer} class for the job.
-
- @return the {@link Reducer} class for the job.]]>
- </doc>
- </method>
- <method name="getOutputFormatClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the {@link OutputFormat} class for the job.
-
- @return the {@link OutputFormat} class for the job.]]>
- </doc>
- </method>
- <method name="getPartitionerClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <doc>
- <![CDATA[Get the {@link Partitioner} class for the job.
-
- @return the {@link Partitioner} class for the job.]]>
- </doc>
- </method>
- <method name="getSortComparator" return="org.apache.hadoop.io.RawComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link RawComparator} comparator used to compare keys.
-
- @return the {@link RawComparator} comparator used to compare keys.]]>
- </doc>
- </method>
- <method name="getJar" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the pathname of the job's jar.
- @return the pathname]]>
- </doc>
- </method>
- <method name="getGroupingComparator" return="org.apache.hadoop.io.RawComparator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user defined {@link RawComparator} comparator for
- grouping keys of inputs to the reduce.
-
- @return comparator set by the user for grouping values.
- @see Job#setGroupingComparatorClass(Class) for details.]]>
- </doc>
- </method>
- <field name="INPUT_FORMAT_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="MAP_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="COMBINE_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="OUTPUT_FORMAT_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="PARTITIONER_CLASS_ATTR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="conf" type="org.apache.hadoop.mapred.JobConf"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="credentials" type="org.apache.hadoop.security.Credentials"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="JOB_NAMENODES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_ACL_VIEW_JOB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_ACL_MODIFY_JOB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CACHE_FILE_VISIBILITIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CACHE_ARCHIVES_VISIBILITIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_CANCEL_DELEGATION_TOKEN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USER_LOG_RETAIN_HOURS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ugi" type="org.apache.hadoop.security.UserGroupInformation"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The UserGroupInformation object that has a reference to the current user]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A read-only view of the job that is provided to the tasks while they
- are running.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobContext -->
- <!-- start class org.apache.hadoop.mapreduce.JobID -->
- <class name="JobID" extends="org.apache.hadoop.mapred.ID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="JobID" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a JobID object
- @param jtIdentifier jobTracker identifier
- @param id job number]]>
- </doc>
- </constructor>
- <constructor name="JobID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getJtIdentifier" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
- <doc>
- <![CDATA[Compare JobIds by first jtIdentifiers, then by job numbers]]>
- </doc>
- </method>
- <method name="appendTo" return="java.lang.StringBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="builder" type="java.lang.StringBuilder"/>
- <doc>
- <![CDATA[Add the stuff after the "job" prefix to the given builder. This is useful,
- because the sub-ids use this substring at the start of their string.
- @param builder the builder to append to
- @return the builder that was passed in]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="forName" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a JobId object from given string
- @return constructed JobId object or null if the given String is null
- @throws IllegalArgumentException if the given string is malformed]]>
- </doc>
- </method>
- <field name="JOB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="JOBID_REGEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="idFormat" type="java.text.NumberFormat"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[JobID represents the immutable and unique identifier for
- the job. JobID consists of two parts. First part
- represents the jobtracker identifier, so that jobID to jobtracker map
- is defined. For cluster setup this string is the jobtracker
- start time, for local setting, it is "local".
- Second part of the JobID is the job number. <br>
- An example JobID is :
- <code>job_200707121733_0003</code> , which represents the third job
- running at the jobtracker started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse JobID strings, but rather
- use appropriate constructors or {@link #forName(String)} method.
-
- @see TaskID
- @see TaskAttemptID
- @see org.apache.hadoop.mapred.JobTracker#getNewJobId()
- @see org.apache.hadoop.mapred.JobTracker#getStartTime()]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobID -->
- <!-- start class org.apache.hadoop.mapreduce.JobStatus -->
- <class name="JobStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Describes the current status of a job.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobStatus -->
- <!-- start class org.apache.hadoop.mapreduce.JobStatus.State -->
- <class name="JobStatus.State" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.JobStatus.State[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.JobStatus.State"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getValue" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="RUNNING" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUCCEEDED" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PREP" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.mapreduce.JobStatus.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Current state of the job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobStatus.State -->
- <!-- start class org.apache.hadoop.mapreduce.JobSubmissionFiles -->
- <class name="JobSubmissionFiles" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobSubmissionFiles"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getJobSplitFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmissionDir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getJobSplitMetaFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmissionDir" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getJobConfPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the job conf path.]]>
- </doc>
- </method>
- <method name="getJobJar" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the job jar path.]]>
- </doc>
- </method>
- <method name="getJobDistCacheFiles" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the job distributed cache files path.
- @param jobSubmitDir]]>
- </doc>
- </method>
- <method name="getJobDistCacheArchives" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the job distributed cache archives path.
- @param jobSubmitDir]]>
- </doc>
- </method>
- <method name="getJobDistCacheLibjars" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Get the job distributed cache libjars path.
- @param jobSubmitDir]]>
- </doc>
- </method>
- <method name="getStagingDir" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="client" type="org.apache.hadoop.mapred.JobClient"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Initializes the staging directory and returns the path. It also
- keeps track of all necessary ownership & permissions
- @param client
- @param conf]]>
- </doc>
- </method>
- <field name="JOB_DIR_PERMISSION" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_FILE_PERMISSION" type="org.apache.hadoop.fs.permission.FsPermission"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A utility to manage job submission files.<br/>
- <b><i>Note that this class is for framework internal usage only and is
- not to be used by users directly.</i></b>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.JobSubmissionFiles -->
- <!-- start class org.apache.hadoop.mapreduce.MapContext -->
- <class name="MapContext" extends="org.apache.hadoop.mapreduce.TaskInputOutputContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordReader, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.mapreduce.InputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInputSplit" return="org.apache.hadoop.mapreduce.InputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the input split for this map.]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[The context that is given to the {@link Mapper}.
- @param <KEYIN> the key input type to the Mapper
- @param <VALUEIN> the value input type to the Mapper
- @param <KEYOUT> the key output type from the Mapper
- @param <VALUEOUT> the value output type from the Mapper]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.MapContext -->
- <!-- start class org.apache.hadoop.mapreduce.Mapper -->
- <class name="Mapper" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Mapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once at the beginning of the task.]]>
- </doc>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once for each key/value pair in the input split. Most applications
- should override this, but the default is the identity function.]]>
- </doc>
- </method>
- <method name="cleanup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once at the end of the task.]]>
- </doc>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Expert users can override this method for more complete control over the
- execution of the Mapper.
- @param context
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Maps input key/value pairs to a set of intermediate key/value pairs.
-
- <p>Maps are the individual tasks which transform input records into a
- intermediate records. The transformed intermediate records need not be of
- the same type as the input records. A given input pair may map to zero or
- many output pairs.</p>
-
- <p>The Hadoop Map-Reduce framework spawns one map task for each
- {@link InputSplit} generated by the {@link InputFormat} for the job.
- <code>Mapper</code> implementations can access the {@link Configuration} for
- the job via the {@link JobContext#getConfiguration()}.
-
- <p>The framework first calls
- {@link #setup(org.apache.hadoop.mapreduce.Mapper.Context)}, followed by
- {@link #map(Object, Object, Context)}
- for each key/value pair in the <code>InputSplit</code>. Finally
- {@link #cleanup(Context)} is called.</p>
-
- <p>All intermediate values associated with a given output key are
- subsequently grouped by the framework, and passed to a {@link Reducer} to
- determine the final output. Users can control the sorting and grouping by
- specifying two key {@link RawComparator} classes.</p>
- <p>The <code>Mapper</code> outputs are partitioned per
- <code>Reducer</code>. Users can control which keys (and hence records) go to
- which <code>Reducer</code> by implementing a custom {@link Partitioner}.
-
- <p>Users can optionally specify a <code>combiner</code>, via
- {@link Job#setCombinerClass(Class)}, to perform local aggregation of the
- intermediate outputs, which helps to cut down the amount of data transferred
- from the <code>Mapper</code> to the <code>Reducer</code>.
-
- <p>Applications can specify if and how the intermediate
- outputs are to be compressed and which {@link CompressionCodec}s are to be
- used via the <code>Configuration</code>.</p>
-
- <p>If the job has zero
- reduces then the output of the <code>Mapper</code> is directly written
- to the {@link OutputFormat} without sorting by keys.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class TokenCounterMapper
- extends Mapper<Object, Text, Text, IntWritable>{
-
- private final static IntWritable one = new IntWritable(1);
- private Text word = new Text();
-
- public void map(Object key, Text value, Context context) throws IOException {
- StringTokenizer itr = new StringTokenizer(value.toString());
- while (itr.hasMoreTokens()) {
- word.set(itr.nextToken());
- context.collect(word, one);
- }
- }
- }
- </pre></blockquote></p>
- <p>Applications may override the {@link #run(Context)} method to exert
- greater control on map processing e.g. multi-threaded <code>Mapper</code>s
- etc.</p>
-
- @see InputFormat
- @see JobContext
- @see Partitioner
- @see Reducer]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Mapper -->
- <!-- start class org.apache.hadoop.mapreduce.Mapper.Context -->
- <class name="Mapper.Context" extends="org.apache.hadoop.mapreduce.MapContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Mapper.Context" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordReader, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.mapreduce.InputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Mapper.Context -->
- <!-- start class org.apache.hadoop.mapreduce.OutputCommitter -->
- <class name="OutputCommitter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OutputCommitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setupJob"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For the framework to setup the job output during initialization
-
- @param jobContext Context of the job whose output is being written.
- @throws IOException if temporary output could not be created]]>
- </doc>
- </method>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For cleaning up the job's output after job completion. Note that this
- is invoked for jobs with final run state as
- {@link JobStatus.State#SUCCEEDED}
-
- @param jobContext Context of the job whose output is being written.
- @throws IOException]]>
- </doc>
- </method>
- <method name="cleanupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="use {@link #commitJob(JobContext)} or
- {@link #abortJob(JobContext, JobStatus.State)} instead">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For cleaning up the job's output after job completion
- @deprecated use {@link #commitJob(JobContext)} or
- {@link #abortJob(JobContext, JobStatus.State)} instead]]>
- </doc>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="state" type="org.apache.hadoop.mapreduce.JobStatus.State"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[For aborting an unsuccessful job's output. Note that this is invoked for
- jobs with final run state as {@link JobStatus.State#FAILED} or
- {@link JobStatus.State#KILLED}.
- @param jobContext Context of the job whose output is being written.
- @param state final run state of the job, should be either
- {@link JobStatus.State#KILLED} or {@link JobStatus.State#FAILED}
- @throws IOException]]>
- </doc>
- </method>
- <method name="setupTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets up output for the task.
-
- @param taskContext Context of the task whose output is being written.
- @throws IOException]]>
- </doc>
- </method>
- <method name="needsTaskCommit" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Check whether task needs a commit
-
- @param taskContext
- @return true/false
- @throws IOException]]>
- </doc>
- </method>
- <method name="commitTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[To promote the task's temporary output to final output location
-
- The task's output is moved to the job's output directory.
-
- @param taskContext Context of the task whose output is being written.
- @throws IOException if commit is not]]>
- </doc>
- </method>
- <method name="abortTask"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Discard the task output
-
- @param taskContext
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>OutputCommitter</code> describes the commit of task output for a
- Map-Reduce job.
- <p>The Map-Reduce framework relies on the <code>OutputCommitter</code> of
- the job to:<p>
- <ol>
- <li>
- Setup the job during initialization. For example, create the temporary
- output directory for the job during the initialization of the job.
- </li>
- <li>
- Cleanup the job after the job completion. For example, remove the
- temporary output directory after the job completion.
- </li>
- <li>
- Setup the task temporary output.
- </li>
- <li>
- Check whether a task needs a commit. This is to avoid the commit
- procedure if a task does not need commit.
- </li>
- <li>
- Commit of the task output.
- </li>
- <li>
- Discard the task commit.
- </li>
- </ol>
-
- @see org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter
- @see JobContext
- @see TaskAttemptContext]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.OutputCommitter -->
- <!-- start class org.apache.hadoop.mapreduce.OutputFormat -->
- <class name="OutputFormat" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the {@link RecordWriter} for the given task.
- @param context the information about the current task.
- @return a {@link RecordWriter} to write the output for the job.
- @throws IOException]]>
- </doc>
- </method>
- <method name="checkOutputSpecs"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Check for validity of the output-specification for the job.
-
- <p>This is to validate the output specification for the job when it is
- a job is submitted. Typically checks that it does not already exist,
- throwing an exception when it already exists, so that output is not
- overwritten.</p>
- @param context information about the job
- @throws IOException when output should not be attempted]]>
- </doc>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the output committer for this output format. This is responsible
- for ensuring the output is committed correctly.
- @param context the task context
- @return an output committer
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>OutputFormat</code> describes the output-specification for a
- Map-Reduce job.
- <p>The Map-Reduce framework relies on the <code>OutputFormat</code> of the
- job to:<p>
- <ol>
- <li>
- Validate the output-specification of the job. For e.g. check that the
- output directory doesn't already exist.
- <li>
- Provide the {@link RecordWriter} implementation to be used to write out
- the output files of the job. Output files are stored in a
- {@link FileSystem}.
- </li>
- </ol>
-
- @see RecordWriter]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.OutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.Partitioner -->
- <class name="Partitioner" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Partitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPartition" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numPartitions" type="int"/>
- <doc>
- <![CDATA[Get the partition number for a given key (hence record) given the total
- number of partitions i.e. number of reduce-tasks for the job.
-
- <p>Typically a hash function on a all or a subset of the key.</p>
- @param key the key to be partioned.
- @param value the entry value.
- @param numPartitions the total number of partitions.
- @return the partition number for the <code>key</code>.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Partitions the key space.
-
- <p><code>Partitioner</code> controls the partitioning of the keys of the
- intermediate map-outputs. The key (or a subset of the key) is used to derive
- the partition, typically by a hash function. The total number of partitions
- is the same as the number of reduce tasks for the job. Hence this controls
- which of the <code>m</code> reduce tasks the intermediate key (and hence the
- record) is sent for reduction.</p>
-
- @see Reducer]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Partitioner -->
- <!-- start class org.apache.hadoop.mapreduce.RecordReader -->
- <class name="RecordReader" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="RecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once at initialization.
- @param split the split that defines the range of records to read
- @param context the information about the task
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Read the next key, value pair.
- @return true if a key/value pair was read
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the current key
- @return the current key or null if there is no current key
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the current value.
- @return the object that was read
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[The current progress of the record reader through its data.
- @return a number between 0.0 and 1.0 that is the fraction of the data read
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="close"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Close the record reader.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The record reader breaks the data into key/value pairs for input to the
- {@link Mapper}.
- @param <KEYIN>
- @param <VALUEIN>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.RecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.RecordWriter -->
- <class name="RecordWriter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RecordWriter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Writes a key/value pair.
- @param key the key to write.
- @param value the value to write.
- @throws IOException]]>
- </doc>
- </method>
- <method name="close"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Close this <code>RecordWriter</code> to future operations.
-
- @param context the context of the task
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<code>RecordWriter</code> writes the output <key, value> pairs
- to an output file.
- <p><code>RecordWriter</code> implementations write the job outputs to the
- {@link FileSystem}.
-
- @see OutputFormat]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.RecordWriter -->
- <!-- start class org.apache.hadoop.mapreduce.ReduceContext -->
- <class name="ReduceContext" extends="org.apache.hadoop.mapreduce.TaskInputOutputContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReduceContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapred.RawKeyValueIterator, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="nextKey" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Start processing next unique key.]]>
- </doc>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Advance to the next key/value pair.]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getValues" return="java.lang.Iterable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Iterate through the values for the current key, reusing the same value
- object, which is stored in the context.
- @return the series of values associated with the current key. All of the
- objects returned directly and indirectly from this method are reused.]]>
- </doc>
- </method>
- <field name="reporter" type="org.apache.hadoop.util.Progressable"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The context passed to the {@link Reducer}.
- @param <KEYIN> the class of the input keys
- @param <VALUEIN> the class of the input values
- @param <KEYOUT> the class of the output keys
- @param <VALUEOUT> the class of the output values]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.ReduceContext -->
- <!-- start class org.apache.hadoop.mapreduce.ReduceContext.ValueIterable -->
- <class name="ReduceContext.ValueIterable" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="java.lang.Iterable"/>
- <constructor name="ReduceContext.ValueIterable"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="iterator" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.ReduceContext.ValueIterable -->
- <!-- start class org.apache.hadoop.mapreduce.ReduceContext.ValueIterator -->
- <class name="ReduceContext.ValueIterator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <implements name="java.util.Iterator"/>
- <constructor name="ReduceContext.ValueIterator"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="hasNext" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="next" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="remove"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.ReduceContext.ValueIterator -->
- <!-- start class org.apache.hadoop.mapreduce.Reducer -->
- <class name="Reducer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Reducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once at the start of the task.]]>
- </doc>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.lang.Iterable"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[This method is called once for each key. Most applications will define
- their reduce class by overriding this method. The default implementation
- is an identity function.]]>
- </doc>
- </method>
- <method name="cleanup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Called once at the end of the task.]]>
- </doc>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Advanced application writers can use the
- {@link #run(org.apache.hadoop.mapreduce.Reducer.Context)} method to
- control how the reduce task works.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Reduces a set of intermediate values which share a key to a smaller set of
- values.
-
- <p><code>Reducer</code> implementations
- can access the {@link Configuration} for the job via the
- {@link JobContext#getConfiguration()} method.</p>
- <p><code>Reducer</code> has 3 primary phases:</p>
- <ol>
- <li>
-
- <h4 id="Shuffle">Shuffle</h4>
-
- <p>The <code>Reducer</code> copies the sorted output from each
- {@link Mapper} using HTTP across the network.</p>
- </li>
-
- <li>
- <h4 id="Sort">Sort</h4>
-
- <p>The framework merge sorts <code>Reducer</code> inputs by
- <code>key</code>s
- (since different <code>Mapper</code>s may have output the same key).</p>
-
- <p>The shuffle and sort phases occur simultaneously i.e. while outputs are
- being fetched they are merged.</p>
-
- <h5 id="SecondarySort">SecondarySort</h5>
-
- <p>To achieve a secondary sort on the values returned by the value
- iterator, the application should extend the key with the secondary
- key and define a grouping comparator. The keys will be sorted using the
- entire key, but will be grouped using the grouping comparator to decide
- which keys and values are sent in the same call to reduce.The grouping
- comparator is specified via
- {@link Job#setGroupingComparatorClass(Class)}. The sort order is
- controlled by
- {@link Job#setSortComparatorClass(Class)}.</p>
-
-
- For example, say that you want to find duplicate web pages and tag them
- all with the url of the "best" known example. You would set up the job
- like:
- <ul>
- <li>Map Input Key: url</li>
- <li>Map Input Value: document</li>
- <li>Map Output Key: document checksum, url pagerank</li>
- <li>Map Output Value: url</li>
- <li>Partitioner: by checksum</li>
- <li>OutputKeyComparator: by checksum and then decreasing pagerank</li>
- <li>OutputValueGroupingComparator: by checksum</li>
- </ul>
- </li>
-
- <li>
- <h4 id="Reduce">Reduce</h4>
-
- <p>In this phase the
- {@link #reduce(Object, Iterable, Context)}
- method is called for each <code><key, (collection of values)></code> in
- the sorted inputs.</p>
- <p>The output of the reduce task is typically written to a
- {@link RecordWriter} via
- {@link Context#write(Object, Object)}.</p>
- </li>
- </ol>
-
- <p>The output of the <code>Reducer</code> is <b>not re-sorted</b>.</p>
-
- <p>Example:</p>
- <p><blockquote><pre>
- public class IntSumReducer<Key> extends Reducer<Key,IntWritable,
- Key,IntWritable> {
- private IntWritable result = new IntWritable();
-
- public void reduce(Key key, Iterable<IntWritable> values,
- Context context) throws IOException {
- int sum = 0;
- for (IntWritable val : values) {
- sum += val.get();
- }
- result.set(sum);
- context.collect(key, result);
- }
- }
- </pre></blockquote></p>
-
- @see Mapper
- @see Partitioner]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Reducer -->
- <!-- start class org.apache.hadoop.mapreduce.Reducer.Context -->
- <class name="Reducer.Context" extends="org.apache.hadoop.mapreduce.ReduceContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Reducer.Context" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapred.RawKeyValueIterator, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.Reducer.Context -->
- <!-- start class org.apache.hadoop.mapreduce.StatusReporter -->
- <class name="StatusReporter" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StatusReporter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.Enum"/>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="group" type="java.lang.String"/>
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="progress"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current progress.
- @return a number between 0.0 and 1.0 (inclusive) indicating the attempt's
- progress.]]>
- </doc>
- </method>
- <method name="setStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.StatusReporter -->
- <!-- start class org.apache.hadoop.mapreduce.TaskAttemptContext -->
- <class name="TaskAttemptContext" extends="org.apache.hadoop.mapreduce.JobContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Progressable"/>
- <constructor name="TaskAttemptContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTaskAttemptID" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the unique name for this task attempt.]]>
- </doc>
- </method>
- <method name="setStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="msg" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the current status of the task to the given string.]]>
- </doc>
- </method>
- <method name="getStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the last set status message.
- @return the current status message]]>
- </doc>
- </method>
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Report progress. The subtypes actually do work in this method.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The context for task attempts.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.TaskAttemptContext -->
- <!-- start class org.apache.hadoop.mapreduce.TaskAttemptID -->
- <class name="TaskAttemptID" extends="org.apache.hadoop.mapred.ID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskAttemptID" type="org.apache.hadoop.mapreduce.TaskID, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskAttemptID object from given {@link TaskID}.
- @param taskId TaskID that this task belongs to
- @param id the task attempt number]]>
- </doc>
- </constructor>
- <constructor name="TaskAttemptID" type="java.lang.String, int, boolean, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskId object from given parts.
- @param jtIdentifier jobTracker identifier
- @param jobId job number
- @param isMap whether the tip is a map
- @param taskId taskId number
- @param id the task attempt number]]>
- </doc>
- </constructor>
- <constructor name="TaskAttemptID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the {@link JobID} object that this task attempt belongs to]]>
- </doc>
- </method>
- <method name="getTaskID" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the {@link TaskID} object that this task attempt belongs to]]>
- </doc>
- </method>
- <method name="isMap" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns whether this TaskAttemptID is a map ID]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="appendTo" return="java.lang.StringBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="builder" type="java.lang.StringBuilder"/>
- <doc>
- <![CDATA[Add the unique string to the StringBuilder
- @param builder the builder to append ot
- @return the builder that was passed in.]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
- <doc>
- <![CDATA[Compare TaskIds by first tipIds, then by task numbers.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="forName" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a TaskAttemptID object from given string
- @return constructed TaskAttemptID object or null if the given String is null
- @throws IllegalArgumentException if the given string is malformed]]>
- </doc>
- </method>
- <field name="ATTEMPT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[TaskAttemptID represents the immutable and unique identifier for
- a task attempt. Each task attempt is one particular instance of a Map or
- Reduce Task identified by its TaskID.
-
- TaskAttemptID consists of 2 parts. First part is the
- {@link TaskID}, that this TaskAttemptID belongs to.
- Second part is the task attempt number. <br>
- An example TaskAttemptID is :
- <code>attempt_200707121733_0003_m_000005_0</code> , which represents the
- zeroth task attempt for the fifth map task in the third job
- running at the jobtracker started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse TaskAttemptID strings
- , but rather use appropriate constructors or {@link #forName(String)}
- method.
-
- @see JobID
- @see TaskID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.TaskAttemptID -->
- <!-- start class org.apache.hadoop.mapreduce.TaskID -->
- <class name="TaskID" extends="org.apache.hadoop.mapred.ID"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskID" type="org.apache.hadoop.mapreduce.JobID, boolean, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskID object from given {@link JobID}.
- @param jobId JobID that this tip belongs to
- @param isMap whether the tip is a map
- @param id the tip number]]>
- </doc>
- </constructor>
- <constructor name="TaskID" type="java.lang.String, int, boolean, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a TaskInProgressId object from given parts.
- @param jtIdentifier jobTracker identifier
- @param jobId job number
- @param isMap whether the tip is a map
- @param id the tip number]]>
- </doc>
- </constructor>
- <constructor name="TaskID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the {@link JobID} object that this tip belongs to]]>
- </doc>
- </method>
- <method name="isMap" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns whether this TaskID is a map ID]]>
- </doc>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
- <doc>
- <![CDATA[Compare TaskInProgressIds by first jobIds, then by tip numbers. Reduces are
- defined as greater then maps.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="appendTo" return="java.lang.StringBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="builder" type="java.lang.StringBuilder"/>
- <doc>
- <![CDATA[Add the unique string to the given builder.
- @param builder the builder to append to
- @return the builder that was passed in]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="forName" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="str" type="java.lang.String"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[Construct a TaskID object from given string
- @return constructed TaskID object or null if the given String is null
- @throws IllegalArgumentException if the given string is malformed]]>
- </doc>
- </method>
- <field name="TASK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="idFormat" type="java.text.NumberFormat"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[TaskID represents the immutable and unique identifier for
- a Map or Reduce Task. Each TaskID encompasses multiple attempts made to
- execute the Map or Reduce Task, each of which are uniquely indentified by
- their TaskAttemptID.
-
- TaskID consists of 3 parts. First part is the {@link JobID}, that this
- TaskInProgress belongs to. Second part of the TaskID is either 'm' or 'r'
- representing whether the task is a map task or a reduce task.
- And the third part is the task number. <br>
- An example TaskID is :
- <code>task_200707121733_0003_m_000005</code> , which represents the
- fifth map task in the third job running at the jobtracker
- started at <code>200707121733</code>.
- <p>
- Applications should never construct or parse TaskID strings
- , but rather use appropriate constructors or {@link #forName(String)}
- method.
-
- @see JobID
- @see TaskAttemptID]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.TaskID -->
- <!-- start class org.apache.hadoop.mapreduce.TaskInputOutputContext -->
- <class name="TaskInputOutputContext" extends="org.apache.hadoop.mapreduce.TaskAttemptContext"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Progressable"/>
- <constructor name="TaskInputOutputContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="nextKeyValue" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Advance to the next key, value pair, returning null if at end.
- @return the key object that was read into, or null if no more]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the current key.
- @return the current key object or null if there isn't one
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the current value.
- @return the value object that was read into
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Generate an output key/value pair.]]>
- </doc>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counterName" type="java.lang.Enum"/>
- </method>
- <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="groupName" type="java.lang.String"/>
- <param name="counterName" type="java.lang.String"/>
- </method>
- <method name="progress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="java.lang.String"/>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A context object that allows input and output from the task. It is only
- supplied to the {@link Mapper} or {@link Reducer}.
- @param <KEYIN> the input key type for the task
- @param <VALUEIN> the input value type for the task
- @param <KEYOUT> the output key type for the task
- @param <VALUEOUT> the output value type for the task]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.TaskInputOutputContext -->
- <!-- start class org.apache.hadoop.mapreduce.TaskType -->
- <class name="TaskType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.TaskType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="MAP" type="org.apache.hadoop.mapreduce.TaskType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE" type="org.apache.hadoop.mapreduce.TaskType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_SETUP" type="org.apache.hadoop.mapreduce.TaskType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_CLEANUP" type="org.apache.hadoop.mapreduce.TaskType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_CLEANUP" type="org.apache.hadoop.mapreduce.TaskType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Enum for map, reduce, job-setup, job-cleanup, task-cleanup task types.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.TaskType -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.db">
- <!-- start class org.apache.hadoop.mapreduce.lib.db.BigDecimalSplitter -->
- <class name="BigDecimalSplitter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.db.DBSplitter"/>
- <constructor name="BigDecimalSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <method name="tryDivide" return="java.math.BigDecimal"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="numerator" type="java.math.BigDecimal"/>
- <param name="denominator" type="java.math.BigDecimal"/>
- <doc>
- <![CDATA[Divide numerator by denominator. If impossible in exact mode, use rounding.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over BigDecimal values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.BigDecimalSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.BooleanSplitter -->
- <class name="BooleanSplitter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.db.DBSplitter"/>
- <constructor name="BooleanSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over boolean values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.BooleanSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBInputFormat -->
- <class name="DataDrivenDBInputFormat" extends="org.apache.hadoop.mapreduce.lib.db.DBInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="DataDrivenDBInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplitter" return="org.apache.hadoop.mapreduce.lib.db.DBSplitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="sqlDataType" type="int"/>
- <doc>
- <![CDATA[@return the DBSplitter implementation to use to divide the table/query into InputSplits.]]>
- </doc>
- </method>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getBoundingValsQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return a query which returns the minimum and maximum values for
- the order-by column.
- The min value should be in the first column, and the
- max value should be in the second column of the results.]]>
- </doc>
- </method>
- <method name="setBoundingQuery"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="query" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user-defined bounding query to use with a user-defined query.
- This *must* include the substring "$CONDITIONS"
- (DataDrivenDBInputFormat.SUBSTITUTE_TOKEN) inside the WHERE clause,
- so that DataDrivenDBInputFormat knows where to insert split clauses.
- e.g., "SELECT foo FROM mytable WHERE $CONDITIONS"
- This will be expanded to something like:
- SELECT foo FROM mytable WHERE (id > 100) AND (id < 250)
- inside each split.]]>
- </doc>
- </method>
- <method name="createDBRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="conditions" type="java.lang.String"/>
- <param name="splitBy" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Note that the "orderBy" column is called the "splitBy" in this version.
- We reuse the same field, but it's not strictly ordering it -- just partitioning
- the results.]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="inputQuery" type="java.lang.String"/>
- <param name="inputBoundingQuery" type="java.lang.String"/>
- <doc>
- <![CDATA[setInput() takes a custom query and a separate "bounding query" to use
- instead of the custom "count query" used by DBInputFormat.]]>
- </doc>
- </method>
- <field name="SUBSTITUTE_TOKEN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If users are providing their own query, the following string is expected to
- appear in the WHERE clause, which will be substituted with a pair of conditions
- on the input to allow input splits to parallelise the import.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A InputFormat that reads input data from an SQL table.
- Operates like DBInputFormat, but instead of using LIMIT and OFFSET to demarcate
- splits, it tries to generate WHERE clauses which separate the data into roughly
- equivalent shards.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBInputFormat.DataDrivenDBInputSplit -->
- <class name="DataDrivenDBInputFormat.DataDrivenDBInputSplit" extends="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DataDrivenDBInputFormat.DataDrivenDBInputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default Constructor]]>
- </doc>
- </constructor>
- <constructor name="DataDrivenDBInputFormat.DataDrivenDBInputSplit" type="java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convenience Constructor
- @param lower the string to be put in the WHERE clause to guard on the 'lower' end
- @param upper the string to be put in the WHERE clause to guard on the 'upper' end]]>
- </doc>
- </constructor>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return The total row count in this split]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="output" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getLowerClause" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getUpperClause" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A InputSplit that spans a set of rows]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBInputFormat.DataDrivenDBInputSplit -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBRecordReader -->
- <class name="DataDrivenDBRecordReader" extends="org.apache.hadoop.mapreduce.lib.db.DBRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DataDrivenDBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[@param split The InputSplit to read data for
- @throws SQLException]]>
- </doc>
- </constructor>
- <method name="getSelectQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for selecting the records,
- subclasses can override this for custom behaviour.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A RecordReader that reads records from a SQL table,
- using data-driven WHERE clause splits.
- Emits LongWritables containing the record number as
- key and DBWritables as value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DataDrivenDBRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DateSplitter -->
- <class name="DateSplitter" extends="org.apache.hadoop.mapreduce.lib.db.IntegerSplitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DateSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <method name="dateToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="d" type="java.util.Date"/>
- <doc>
- <![CDATA[Given a Date 'd', format it as a string for use in a SQL date
- comparison operation.
- @param d the date to format.
- @return the string representing this date in SQL with any appropriate
- quotation characters, etc.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over date/time values.
- Make use of logic from IntegerSplitter, since date/time are just longs
- in Java.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DateSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBConfiguration -->
- <class name="DBConfiguration" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DBConfiguration" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configureDB"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="driverClass" type="java.lang.String"/>
- <param name="dbUrl" type="java.lang.String"/>
- <param name="userName" type="java.lang.String"/>
- <param name="passwd" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the DB access related fields in the {@link Configuration}.
- @param conf the configuration
- @param driverClass JDBC Driver class name
- @param dbUrl JDBC DB access URL.
- @param userName DB access username
- @param passwd DB access passwd]]>
- </doc>
- </method>
- <method name="configureDB"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.conf.Configuration"/>
- <param name="driverClass" type="java.lang.String"/>
- <param name="dbUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Sets the DB access related fields in the JobConf.
- @param job the job
- @param driverClass JDBC Driver class name
- @param dbUrl JDBC DB access URL.]]>
- </doc>
- </method>
- <method name="getConnection" return="java.sql.Connection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Returns a connection object o the DB
- @throws ClassNotFoundException
- @throws SQLException]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputTableName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputTableName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tableName" type="java.lang.String"/>
- </method>
- <method name="getInputFieldNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputFieldNames"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldNames" type="java.lang.String[]"/>
- </method>
- <method name="getInputConditions" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputConditions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conditions" type="java.lang.String"/>
- </method>
- <method name="getInputOrderBy" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputOrderBy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="orderby" type="java.lang.String"/>
- </method>
- <method name="getInputQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputQuery"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- </method>
- <method name="getInputCountQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputCountQuery"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- </method>
- <method name="setInputBoundingQuery"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- </method>
- <method name="getInputBoundingQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputClass"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputClass" type="java.lang.Class"/>
- </method>
- <method name="getOutputTableName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setOutputTableName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tableName" type="java.lang.String"/>
- </method>
- <method name="getOutputFieldNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setOutputFieldNames"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldNames" type="java.lang.String[]"/>
- </method>
- <method name="setOutputFieldCount"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldCount" type="int"/>
- </method>
- <method name="getOutputFieldCount" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="DRIVER_CLASS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The JDBC Driver class name]]>
- </doc>
- </field>
- <field name="URL_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[JDBC Database access URL]]>
- </doc>
- </field>
- <field name="USERNAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[User name to access the database]]>
- </doc>
- </field>
- <field name="PASSWORD_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Password to access the database]]>
- </doc>
- </field>
- <field name="INPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Input table name]]>
- </doc>
- </field>
- <field name="INPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Field names in the Input table]]>
- </doc>
- </field>
- <field name="INPUT_CONDITIONS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[WHERE clause in the input SELECT statement]]>
- </doc>
- </field>
- <field name="INPUT_ORDER_BY_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ORDER BY clause in the input SELECT statement]]>
- </doc>
- </field>
- <field name="INPUT_QUERY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whole input query, exluding LIMIT...OFFSET]]>
- </doc>
- </field>
- <field name="INPUT_COUNT_QUERY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Input query to get the count of records]]>
- </doc>
- </field>
- <field name="INPUT_BOUNDING_QUERY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Input query to get the max and min values of the jdbc.input.query]]>
- </doc>
- </field>
- <field name="INPUT_CLASS_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class name implementing DBWritable which will hold input tuples]]>
- </doc>
- </field>
- <field name="OUTPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Output table name]]>
- </doc>
- </field>
- <field name="OUTPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Field names in the Output table]]>
- </doc>
- </field>
- <field name="OUTPUT_FIELD_COUNT_PROPERTY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of fields in the Output table]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A container for configuration property names for jobs with DB input/output.
-
- The job can be configured using the static methods in this class,
- {@link DBInputFormat}, and {@link DBOutputFormat}.
- Alternatively, the properties can be set in the configuration with proper
- values.
-
- @see DBConfiguration#configureDB(Configuration, String, String, String, String)
- @see DBInputFormat#setInput(Job, Class, String, String)
- @see DBInputFormat#setInput(Job, Class, String, String, String, String...)
- @see DBOutputFormat#setOutput(Job, String, String...)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBConfiguration -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBInputFormat -->
- <class name="DBInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="DBInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDBConf" return="org.apache.hadoop.mapreduce.lib.db.DBConfiguration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getConnection" return="java.sql.Connection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDBProductName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="createDBRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCountQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for getting the total number of rows,
- subclasses can override this for custom behaviour.]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="conditions" type="java.lang.String"/>
- <param name="orderBy" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Initializes the map-part of the job with the appropriate input settings.
-
- @param job The map-reduce job
- @param inputClass the class object implementing DBWritable, which is the
- Java object holding tuple fields.
- @param tableName The table to read data from
- @param conditions The condition which to select data with,
- eg. '(updated > 20070101 AND length > 0)'
- @param orderBy the fieldNames in the orderBy clause.
- @param fieldNames The field names in the table
- @see #setInput(Job, Class, String, String)]]>
- </doc>
- </method>
- <method name="setInput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="inputClass" type="java.lang.Class"/>
- <param name="inputQuery" type="java.lang.String"/>
- <param name="inputCountQuery" type="java.lang.String"/>
- <doc>
- <![CDATA[Initializes the map-part of the job with the appropriate input settings.
-
- @param job The map-reduce job
- @param inputClass the class object implementing DBWritable, which is the
- Java object holding tuple fields.
- @param inputQuery the input query to select fields. Example :
- "SELECT f1, f2, f3 FROM Mytable ORDER BY f1"
- @param inputCountQuery the input query that returns
- the number of records in the table.
- Example : "SELECT COUNT(f1) FROM Mytable"
- @see #setInput(Job, Class, String, String, String, String...)]]>
- </doc>
- </method>
- <method name="closeConnection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A InputFormat that reads input data from an SQL table.
- <p>
- DBInputFormat emits LongWritables containing the record number as
- key and DBWritables as value.
-
- The SQL query, and input class can be using one of the two
- setInput methods.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit -->
- <class name="DBInputFormat.DBInputSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="DBInputFormat.DBInputSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default Constructor]]>
- </doc>
- </constructor>
- <constructor name="DBInputFormat.DBInputSplit" type="long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Convenience Constructor
- @param start the index of the first row to select
- @param end the index of the last row to select]]>
- </doc>
- </constructor>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The index of the first row to select]]>
- </doc>
- </method>
- <method name="getEnd" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return The index of the last row to select]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@return The total row count in this split]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="output" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A InputSplit that spans a set of rows]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBInputFormat.NullDBWritable -->
- <class name="DBInputFormat.NullDBWritable" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.db.DBWritable"/>
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="DBInputFormat.NullDBWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="java.sql.ResultSet"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arg0" type="java.sql.PreparedStatement"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[A Class that does nothing, implementing DBWritable]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBInputFormat.NullDBWritable -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBOutputFormat -->
- <class name="DBOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DBOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="constructQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="table" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Constructs the query used as the prepared statement to insert data.
-
- @param table
- the table to insert into
- @param fieldNames
- the fields to insert into. If field names are unknown, supply an
- array of nulls.]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="setOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="fieldNames" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initializes the reduce-part of the job with
- the appropriate output settings
-
- @param job The job
- @param tableName The table to insert data into
- @param fieldNames The field names in the table.]]>
- </doc>
- </method>
- <method name="setOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="tableName" type="java.lang.String"/>
- <param name="fieldCount" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initializes the reduce-part of the job
- with the appropriate output settings
-
- @param job The job
- @param tableName The table to insert data into
- @param fieldCount the number of fields in the table.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A OutputFormat that sends the reduce output to a SQL table.
- <p>
- {@link DBOutputFormat} accepts <key,value> pairs, where
- key has a type extending DBWritable. Returned {@link RecordWriter}
- writes <b>only the key</b> to the database with a batch SQL query.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBOutputFormat.DBRecordWriter -->
- <class name="DBOutputFormat.DBRecordWriter" extends="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DBOutputFormat.DBRecordWriter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <constructor name="DBOutputFormat.DBRecordWriter" type="java.sql.Connection, java.sql.PreparedStatement"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <method name="getConnection" return="java.sql.Connection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStatement" return="java.sql.PreparedStatement"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.mapreduce.lib.db.DBWritable"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A RecordWriter that writes the reduce output to a SQL table]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBOutputFormat.DBRecordWriter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.DBRecordReader -->
- <class name="DBRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[@param split The InputSplit to read data for
- @throws SQLException]]>
- </doc>
- </constructor>
- <method name="executeQuery" return="java.sql.ResultSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <method name="getSelectQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for selecting the records,
- subclasses can override this for custom behaviour.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.io.LongWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getCurrentValue" return="org.apache.hadoop.mapreduce.lib.db.DBWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="createValue" return="org.apache.hadoop.mapreduce.lib.db.DBWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="deprecated, no comment">
- <doc>
- <![CDATA[@deprecated]]>
- </doc>
- </method>
- <method name="getPos" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="deprecated, no comment">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated]]>
- </doc>
- </method>
- <method name="next" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #nextKeyValue()}">
- <param name="key" type="org.apache.hadoop.io.LongWritable"/>
- <param name="value" type="org.apache.hadoop.mapreduce.lib.db.DBWritable"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@deprecated Use {@link #nextKeyValue()}]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getSplit" return="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getFieldNames" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getTableName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getConditions" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getDBConf" return="org.apache.hadoop.mapreduce.lib.db.DBConfiguration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getConnection" return="java.sql.Connection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getStatement" return="java.sql.PreparedStatement"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="setStatement"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="stmt" type="java.sql.PreparedStatement"/>
- </method>
- <field name="statement" type="java.sql.PreparedStatement"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A RecordReader that reads records from a SQL table.
- Emits LongWritables containing the record number as
- key and DBWritables as value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.DBRecordReader -->
- <!-- start interface org.apache.hadoop.mapreduce.lib.db.DBSplitter -->
- <interface name="DBSplitter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Given a ResultSet containing one record (and already advanced to that record)
- with two columns (a low value, and a high value, both of the same type), determine
- a set of splits that span the given values.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[DBSplitter will generate DBInputSplits to use with DataDrivenDBInputFormat.
- DataDrivenDBInputFormat needs to interpolate between two values that
- represent the lowest and highest valued records to import. Depending
- on the data-type of the column, this requires different behavior.
- DBSplitter implementations should perform this for a data type or family
- of data types.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapreduce.lib.db.DBSplitter -->
- <!-- start interface org.apache.hadoop.mapreduce.lib.db.DBWritable -->
- <interface name="DBWritable" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="statement" type="java.sql.PreparedStatement"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Sets the fields of the object in the {@link PreparedStatement}.
- @param statement the statement that the fields are put into.
- @throws SQLException]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resultSet" type="java.sql.ResultSet"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Reads the fields of the object from the {@link ResultSet}.
- @param resultSet the {@link ResultSet} to get the fields from.
- @throws SQLException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Objects that are read from/written to a database should implement
- <code>DBWritable</code>. DBWritable, is similar to {@link Writable}
- except that the {@link #write(PreparedStatement)} method takes a
- {@link PreparedStatement}, and {@link #readFields(ResultSet)}
- takes a {@link ResultSet}.
- <p>
- Implementations are responsible for writing the fields of the object
- to PreparedStatement, and reading the fields of the object from the
- ResultSet.
-
- <p>Example:</p>
- If we have the following table in the database :
- <pre>
- CREATE TABLE MyTable (
- counter INTEGER NOT NULL,
- timestamp BIGINT NOT NULL,
- );
- </pre>
- then we can read/write the tuples from/to the table with :
- <p><pre>
- public class MyWritable implements Writable, DBWritable {
- // Some data
- private int counter;
- private long timestamp;
-
- //Writable#write() implementation
- public void write(DataOutput out) throws IOException {
- out.writeInt(counter);
- out.writeLong(timestamp);
- }
-
- //Writable#readFields() implementation
- public void readFields(DataInput in) throws IOException {
- counter = in.readInt();
- timestamp = in.readLong();
- }
-
- public void write(PreparedStatement statement) throws SQLException {
- statement.setInt(1, counter);
- statement.setLong(2, timestamp);
- }
-
- public void readFields(ResultSet resultSet) throws SQLException {
- counter = resultSet.getInt(1);
- timestamp = resultSet.getLong(2);
- }
- }
- </pre></p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapreduce.lib.db.DBWritable -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.FloatSplitter -->
- <class name="FloatSplitter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.db.DBSplitter"/>
- <constructor name="FloatSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over floating-point values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.FloatSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.IntegerSplitter -->
- <class name="IntegerSplitter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.db.DBSplitter"/>
- <constructor name="IntegerSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over integer values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.IntegerSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.MySQLDataDrivenDBRecordReader -->
- <class name="MySQLDataDrivenDBRecordReader" extends="org.apache.hadoop.mapreduce.lib.db.DataDrivenDBRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MySQLDataDrivenDBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <method name="executeQuery" return="java.sql.ResultSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[A RecordReader that reads records from a MySQL table via DataDrivenDBRecordReader]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.MySQLDataDrivenDBRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.MySQLDBRecordReader -->
- <class name="MySQLDBRecordReader" extends="org.apache.hadoop.mapreduce.lib.db.DBRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MySQLDBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <method name="executeQuery" return="java.sql.ResultSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="query" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- </method>
- <doc>
- <![CDATA[A RecordReader that reads records from a MySQL table.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.MySQLDBRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.OracleDataDrivenDBInputFormat -->
- <class name="OracleDataDrivenDBInputFormat" extends="org.apache.hadoop.mapreduce.lib.db.DataDrivenDBInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="OracleDataDrivenDBInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplitter" return="org.apache.hadoop.mapreduce.lib.db.DBSplitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="sqlDataType" type="int"/>
- <doc>
- <![CDATA[@return the DBSplitter implementation to use to divide the table/query into InputSplits.]]>
- </doc>
- </method>
- <method name="createDBRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A InputFormat that reads input data from an SQL table in an Oracle db.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.OracleDataDrivenDBInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.OracleDataDrivenDBRecordReader -->
- <class name="OracleDataDrivenDBRecordReader" extends="org.apache.hadoop.mapreduce.lib.db.DataDrivenDBRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OracleDataDrivenDBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <doc>
- <![CDATA[A RecordReader that reads records from a Oracle table via DataDrivenDBRecordReader]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.OracleDataDrivenDBRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.OracleDateSplitter -->
- <class name="OracleDateSplitter" extends="org.apache.hadoop.mapreduce.lib.db.DateSplitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OracleDateSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="dateToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="d" type="java.util.Date"/>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over date/time values returned by an Oracle db.
- Make use of logic from DateSplitter, since this just needs to use
- some Oracle-specific functions on the formatting end when generating
- InputSplits.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.OracleDateSplitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.OracleDBRecordReader -->
- <class name="OracleDBRecordReader" extends="org.apache.hadoop.mapreduce.lib.db.DBRecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OracleDBRecordReader" type="org.apache.hadoop.mapreduce.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.conf.Configuration, java.sql.Connection, org.apache.hadoop.mapreduce.lib.db.DBConfiguration, java.lang.String, java.lang.String[], java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="SQLException" type="java.sql.SQLException"/>
- </constructor>
- <method name="getSelectQuery" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the query for selecting the records from an Oracle DB.]]>
- </doc>
- </method>
- <method name="setSessionTimeZone"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="conn" type="java.sql.Connection"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[Set session time zone
- @param conf The current configuration.
- We read the 'oracle.sessionTimeZone' property from here.
- @param conn The connection to alter the timezone properties of.]]>
- </doc>
- </method>
- <field name="SESSION_TIMEZONE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration key to set to a timezone string.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A RecordReader that reads records from an Oracle SQL table.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.OracleDBRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.db.TextSplitter -->
- <class name="TextSplitter" extends="org.apache.hadoop.mapreduce.lib.db.BigDecimalSplitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TextSplitter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="split" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="results" type="java.sql.ResultSet"/>
- <param name="colName" type="java.lang.String"/>
- <exception name="SQLException" type="java.sql.SQLException"/>
- <doc>
- <![CDATA[This method needs to determine the splits between two user-provided strings.
- In the case where the user's strings are 'A' and 'Z', this is not hard; we
- could create two splits from ['A', 'M') and ['M', 'Z'], 26 splits for strings
- beginning with each letter, etc.
- If a user has provided us with the strings "Ham" and "Haze", however, we need
- to create splits that differ in the third letter.
- The algorithm used is as follows:
- Since there are 2**16 unicode characters, we interpret characters as digits in
- base 65536. Given a string 's' containing characters s_0, s_1 .. s_n, we interpret
- the string as the number: 0.s_0 s_1 s_2.. s_n in base 65536. Having mapped the
- low and high strings into floating-point values, we then use the BigDecimalSplitter
- to establish the even split points, then map the resulting floating point values
- back into strings.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Implement DBSplitter over text strings.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.db.TextSplitter -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.fieldsel">
- <!-- start class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionHelper -->
- <class name="FieldSelectionHelper" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FieldSelectionHelper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FieldSelectionHelper" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="parseOutputKeyValueSpec" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keyValueSpec" type="java.lang.String"/>
- <param name="keyFieldList" type="java.util.List"/>
- <param name="valueFieldList" type="java.util.List"/>
- </method>
- <method name="specToString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fieldSeparator" type="java.lang.String"/>
- <param name="keyValueSpec" type="java.lang.String"/>
- <param name="allValueFieldsFrom" type="int"/>
- <param name="keyFieldList" type="java.util.List"/>
- <param name="valueFieldList" type="java.util.List"/>
- </method>
- <method name="getKey" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="extractOutputKeyValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="val" type="java.lang.String"/>
- <param name="fieldSep" type="java.lang.String"/>
- <param name="keyFieldList" type="java.util.List"/>
- <param name="valFieldList" type="java.util.List"/>
- <param name="allValueFieldsFrom" type="int"/>
- <param name="ignoreKey" type="boolean"/>
- <param name="isMap" type="boolean"/>
- </method>
- <field name="emptyText" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DATA_FIELD_SEPERATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_OUTPUT_KEY_VALUE_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_OUTPUT_KEY_VALUE_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class implements a mapper/reducer class that can be used to perform
- field selections in a manner similar to unix cut. The input data is treated
- as fields separated by a user specified separator (the default value is
- "\t"). The user can specify a list of fields that form the map output keys,
- and a list of fields that form the map output values. If the inputformat is
- TextInputFormat, the mapper will ignore the key to the map function. and the
- fields are from the value only. Otherwise, the fields are the union of those
- from the key and those from the value.
-
- The field separator is under attribute "mapreduce.fieldsel.data.field.separator"
-
- The map output field list spec is under attribute
- "mapreduce.fieldsel.map.output.key.value.fields.spec".
- The value is expected to be like "keyFieldsSpec:valueFieldsSpec"
- key/valueFieldsSpec are comma (,) separated field spec: fieldSpec,fieldSpec,fieldSpec ...
- Each field spec can be a simple number (e.g. 5) specifying a specific field, or a range
- (like 2-5) to specify a range of fields, or an open range (like 3-) specifying all
- the fields starting from field 3. The open range field spec applies value fields only.
- They have no effect on the key fields.
-
- Here is an example: "4,3,0,1:6,5,1-3,7-". It specifies to use fields 4,3,0 and 1 for keys,
- and use fields 6,5,1,2,3,7 and above for values.
-
- The reduce output field list spec is under attribute
- "mapreduce.fieldsel.reduce.output.key.value.fields.spec".
-
- The reducer extracts output key/value pairs in a similar manner, except that
- the key is never ignored.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionHelper -->
- <!-- start class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionMapper -->
- <class name="FieldSelectionMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FieldSelectionMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="val" type="java.lang.Object"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[The identify function. Input key/value pair is written directly to output.]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class implements a mapper class that can be used to perform
- field selections in a manner similar to unix cut. The input data is treated
- as fields separated by a user specified separator (the default value is
- "\t"). The user can specify a list of fields that form the map output keys,
- and a list of fields that form the map output values. If the inputformat is
- TextInputFormat, the mapper will ignore the key to the map function. and the
- fields are from the value only. Otherwise, the fields are the union of those
- from the key and those from the value.
-
- The field separator is under attribute "mapreduce.fieldsel.data.field.separator"
-
- The map output field list spec is under attribute
- "mapreduce.fieldsel.map.output.key.value.fields.spec".
- The value is expected to be like
- "keyFieldsSpec:valueFieldsSpec" key/valueFieldsSpec are comma (,) separated
- field spec: fieldSpec,fieldSpec,fieldSpec ... Each field spec can be a
- simple number (e.g. 5) specifying a specific field, or a range (like 2-5)
- to specify a range of fields, or an open range (like 3-) specifying all
- the fields starting from field 3. The open range field spec applies value
- fields only. They have no effect on the key fields.
-
- Here is an example: "4,3,0,1:6,5,1-3,7-". It specifies to use fields
- 4,3,0 and 1 for keys, and use fields 6,5,1,2,3,7 and above for values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionMapper -->
- <!-- start class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionReducer -->
- <class name="FieldSelectionReducer" extends="org.apache.hadoop.mapreduce.Reducer"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FieldSelectionReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="values" type="java.lang.Iterable"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class implements a reducer class that can be used to perform field
- selections in a manner similar to unix cut.
-
- The input data is treated as fields separated by a user specified
- separator (the default value is "\t"). The user can specify a list of
- fields that form the reduce output keys, and a list of fields that form
- the reduce output values. The fields are the union of those from the key
- and those from the value.
-
- The field separator is under attribute "mapreduce.fieldsel.data.field.separator"
-
- The reduce output field list spec is under attribute
- "mapreduce.fieldsel.reduce.output.key.value.fields.spec".
- The value is expected to be like
- "keyFieldsSpec:valueFieldsSpec" key/valueFieldsSpec are comma (,)
- separated field spec: fieldSpec,fieldSpec,fieldSpec ... Each field spec
- can be a simple number (e.g. 5) specifying a specific field, or a range
- (like 2-5) to specify a range of fields, or an open range (like 3-)
- specifying all the fields starting from field 3. The open range field
- spec applies value fields only. They have no effect on the key fields.
-
- Here is an example: "4,3,0,1:6,5,1-3,7-". It specifies to use fields
- 4,3,0 and 1 for keys, and use fields 6,5,1,2,3,7 and above for values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.fieldsel.FieldSelectionReducer -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.input">
- <!-- start class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat -->
- <class name="CombineFileInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CombineFileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor]]>
- </doc>
- </constructor>
- <method name="setMaxSplitSize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="maxSplitSize" type="long"/>
- <doc>
- <![CDATA[Specify the maximum size (in bytes) of each split. Each split is
- approximately equal to the specified size.]]>
- </doc>
- </method>
- <method name="setMinSplitSizeNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="minSplitSizeNode" type="long"/>
- <doc>
- <![CDATA[Specify the minimum size (in bytes) of each split per node.
- This applies to data that is left over after combining data on a single
- node into splits that are of maximum size specified by maxSplitSize.
- This leftover data will be combined into its own split if its size
- exceeds minSplitSizeNode.]]>
- </doc>
- </method>
- <method name="setMinSplitSizeRack"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="minSplitSizeRack" type="long"/>
- <doc>
- <![CDATA[Specify the minimum size (in bytes) of each split per rack.
- This applies to data that is left over after combining data on a single
- rack into splits that are of maximum size specified by maxSplitSize.
- This leftover data will be combined into its own split if its size
- exceeds minSplitSizeRack.]]>
- </doc>
- </method>
- <method name="createPool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="filters" type="java.util.List"/>
- <doc>
- <![CDATA[Create a new pool and add the filters to it.
- A split cannot have files from different pools.]]>
- </doc>
- </method>
- <method name="createPool"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="filters" type="org.apache.hadoop.fs.PathFilter[]"/>
- <doc>
- <![CDATA[Create a new pool and add the filters to it.
- A pathname can satisfy any one of the specified filters.
- A split cannot have files from different pools.]]>
- </doc>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[This is not implemented yet.]]>
- </doc>
- </method>
- <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="stat" type="org.apache.hadoop.fs.FileStatus"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="SPLIT_MINSIZE_PERNODE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SPLIT_MINSIZE_PERRACK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An abstract {@link InputFormat} that returns {@link CombineFileSplit}'s in
- {@link InputFormat#getSplits(JobContext)} method.
-
- Splits are constructed from the files under the input paths.
- A split cannot have files from different pools.
- Each split returned may contain blocks from different files.
- If a maxSplitSize is specified, then blocks on the same node are
- combined to form a single split. Blocks that are left over are
- then combined with other blocks in the same rack.
- If maxSplitSize is not specified, then blocks from the same rack
- are combined in a single split; no attempt is made to create
- node-local splits.
- If the maxSplitSize is equal to the block size, then this class
- is similar to the default splitting behavior in Hadoop: each
- block is a locally processed split.
- Subclasses implement
- {@link InputFormat#createRecordReader(InputSplit, TaskAttemptContext)}
- to construct <code>RecordReader</code>'s for
- <code>CombineFileSplit</code>'s.
-
- @see CombineFileSplit]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader -->
- <class name="CombineFileRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CombineFileRecordReader" type="org.apache.hadoop.mapreduce.lib.input.CombineFileSplit, org.apache.hadoop.mapreduce.TaskAttemptContext, java.lang.Class"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[A generic RecordReader that can hand out different recordReaders
- for each chunk in the CombineFileSplit.]]>
- </doc>
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[return progress based on the amount of data processed so far.]]>
- </doc>
- </method>
- <method name="initNextRecordReader" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the record reader for the next chunk in this CombineFileSplit.]]>
- </doc>
- </method>
- <field name="split" type="org.apache.hadoop.mapreduce.lib.input.CombineFileSplit"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rrClass" type="java.lang.Class"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rrConstructor" type="java.lang.reflect.Constructor"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="fs" type="org.apache.hadoop.fs.FileSystem"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="idx" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="progress" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="curReader" type="org.apache.hadoop.mapreduce.RecordReader"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A generic RecordReader that can hand out different recordReaders
- for each chunk in a {@link CombineFileSplit}.
- A CombineFileSplit can combine data chunks from multiple files.
- This class allows using different RecordReaders for processing
- these data chunks from different files.
- @see CombineFileSplit]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit -->
- <class name="CombineFileSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="CombineFileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default constructor]]>
- </doc>
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.fs.Path[], long[], long[], java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.fs.Path[], long[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="CombineFileSplit" type="org.apache.hadoop.mapreduce.lib.input.CombineFileSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Copy constructor]]>
- </doc>
- </constructor>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartOffsets" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an array containing the start offsets of the files in the split]]>
- </doc>
- </method>
- <method name="getLengths" return="long[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an array containing the lengths of the files in the split]]>
- </doc>
- </method>
- <method name="getOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the start offset of the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the length of the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getNumPaths" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the number of Paths in the split]]>
- </doc>
- </method>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="i" type="int"/>
- <doc>
- <![CDATA[Returns the i<sup>th</sup> Path]]>
- </doc>
- </method>
- <method name="getPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns all the Paths in the split]]>
- </doc>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Returns all the Paths where this input-split resides]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A sub-collection of input files.
-
- Unlike {@link FileSplit}, CombineFileSplit class does not represent
- a split of a file, but a split of input files into smaller sets.
- A split may contain blocks from different file but all
- the blocks in the same split are probably local to some rack <br>
- CombineFileSplit can be used to implement {@link RecordReader}'s,
- with reading one record per file.
-
- @see FileSplit
- @see CombineFileInputFormat]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.DelegatingInputFormat -->
- <class name="DelegatingInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegatingInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} that delegates behavior of paths to multiple other
- InputFormats.
-
- @see MultipleInputs#addInputPath(Job, Path, Class, Class)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.DelegatingInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.DelegatingMapper -->
- <class name="DelegatingMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegatingMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[An {@link Mapper} that delegates behavior of paths to multiple other
- mappers.
-
- @see MultipleInputs#addInputPath(Job, Path, Class, Class)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.DelegatingMapper -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.DelegatingRecordReader -->
- <class name="DelegatingRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegatingRecordReader" type="org.apache.hadoop.mapreduce.InputSplit, org.apache.hadoop.mapreduce.TaskAttemptContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Constructs the DelegatingRecordReader.
-
- @param split TaggegInputSplit object
- @param context TaskAttemptContext object
-
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[This is a delegating RecordReader, which delegates the functionality to the
- underlying record reader in {@link TaggedInputSplit}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.DelegatingRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.FileInputFormat -->
- <class name="FileInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getFormatMinSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the lower bound on split size imposed by the format.
- @return the number of bytes of the minimal split for this format]]>
- </doc>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="filename" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Is the given filename splitable? Usually, true, but if the file is
- stream compressed, it will not be.
-
- <code>FileInputFormat</code> implementations can override this and return
- <code>false</code> to ensure that individual input files are never split-up
- so that {@link Mapper}s process entire files.
-
- @param context the job context
- @param filename the file name to check
- @return is this file splitable?]]>
- </doc>
- </method>
- <method name="setInputPathFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="filter" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set a PathFilter to be applied to the input paths for the map-reduce job.
- @param job the job to modify
- @param filter the PathFilter class use for filtering the input paths.]]>
- </doc>
- </method>
- <method name="setMinInputSplitSize"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="size" type="long"/>
- <doc>
- <![CDATA[Set the minimum input split size
- @param job the job to modify
- @param size the minimum size]]>
- </doc>
- </method>
- <method name="getMinSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the minimum split size
- @param job the job
- @return the minimum number of bytes that can be in a split]]>
- </doc>
- </method>
- <method name="setMaxInputSplitSize"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="size" type="long"/>
- <doc>
- <![CDATA[Set the maximum split size
- @param job the job to modify
- @param size the maximum split size]]>
- </doc>
- </method>
- <method name="getMaxSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the maximum split size.
- @param context the job to look at.
- @return the maximum number of bytes a split can include]]>
- </doc>
- </method>
- <method name="getInputPathFilter" return="org.apache.hadoop.fs.PathFilter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get a PathFilter instance of the filter set for the input paths.
- @return the PathFilter instance set for the job, NULL if none has been set.]]>
- </doc>
- </method>
- <method name="listStatus" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[List input directories.
- Subclasses may override to, e.g., select only files matching a regular
- expression.
-
- @param job the job to list input paths for
- @return array of FileStatus objects
- @throws IOException if zero items.]]>
- </doc>
- </method>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Generate the list of files and make them into FileSplits.]]>
- </doc>
- </method>
- <method name="computeSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="blockSize" type="long"/>
- <param name="minSize" type="long"/>
- <param name="maxSize" type="long"/>
- </method>
- <method name="getBlockIndex" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
- <param name="offset" type="long"/>
- </method>
- <method name="setInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="commaSeparatedPaths" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sets the given comma separated paths as the list of inputs
- for the map-reduce job.
-
- @param job the job
- @param commaSeparatedPaths Comma separated paths to be set as
- the list of inputs for the map-reduce job.]]>
- </doc>
- </method>
- <method name="addInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="commaSeparatedPaths" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add the given comma separated paths to the list of inputs for
- the map-reduce job.
-
- @param job The job to modify
- @param commaSeparatedPaths Comma separated paths to be added to
- the list of inputs for the map-reduce job.]]>
- </doc>
- </method>
- <method name="setInputPaths"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="inputPaths" type="org.apache.hadoop.fs.Path[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Set the array of {@link Path}s as the list of inputs
- for the map-reduce job.
-
- @param job The job to modify
- @param inputPaths the {@link Path}s of the input directories/files
- for the map-reduce job.]]>
- </doc>
- </method>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Add a {@link Path} to the list of inputs for the map-reduce job.
-
- @param job The {@link Job} to modify
- @param path {@link Path} to be added to the list of inputs for
- the map-reduce job.]]>
- </doc>
- </method>
- <method name="getInputPaths" return="org.apache.hadoop.fs.Path[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the list of input {@link Path}s for the map-reduce job.
-
- @param context The job
- @return the list of input {@link Path}s for the map-reduce job.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A base class for file-based {@link InputFormat}s.
-
- <p><code>FileInputFormat</code> is the base class for all file-based
- <code>InputFormat</code>s. This provides a generic implementation of
- {@link #getSplits(JobContext)}.
- Subclasses of <code>FileInputFormat</code> can also override the
- {@link #isSplitable(JobContext, Path)} method to ensure input-files are
- not split-up and are processed as a whole by {@link Mapper}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.FileInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.FileInputFormat.Counter -->
- <class name="FileInputFormat.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.lib.input.FileInputFormat.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.lib.input.FileInputFormat.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="BYTES_READ" type="org.apache.hadoop.mapreduce.lib.input.FileInputFormat.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.FileInputFormat.Counter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.FileSplit -->
- <class name="FileSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructs a split with host information
- @param file the file name
- @param start the position of the first byte in the file to process
- @param length the number of bytes in the file to process
- @param hosts the list of hosts containing the block, possibly null]]>
- </doc>
- </constructor>
- <method name="getPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The file containing this split's data.]]>
- </doc>
- </method>
- <method name="getStart" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The position of the first byte in the file to process.]]>
- </doc>
- </method>
- <method name="getLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of bytes in the file to process.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A section of an input file. Returned by {@link
- InputFormat#getSplits(JobContext)} and passed to
- {@link InputFormat#createRecordReader(InputSplit,TaskAttemptContext)}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.FileSplit -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.InvalidInputException -->
- <class name="InvalidInputException" extends="java.io.IOException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidInputException" type="java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the exception with the given list.
- @param probs the list of problems to report. this list is not copied.]]>
- </doc>
- </constructor>
- <method name="getProblems" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the complete list of the problems reported.
- @return the list of problems, which must not be modified]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a summary message of the problems found.
- @return the concatenated messages from all of the problems.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class wraps a list of problems with the input, so that the user
- can get a list of problems together instead of finding and fixing them one
- by one.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.InvalidInputException -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.KeyValueLineRecordReader -->
- <class name="KeyValueLineRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KeyValueLineRecordReader" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="findSeparator" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="utf" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="length" type="int"/>
- <param name="sep" type="byte"/>
- </method>
- <method name="setKeyValue"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.Text"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <param name="line" type="byte[]"/>
- <param name="lineLen" type="int"/>
- <param name="pos" type="int"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Read key/value pair in a line.]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCurrentValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="KEY_VALUE_SEPERATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class treats a line in the input as a key/value pair separated by a
- separator character. The separator can be specified in config file
- under the attribute name mapreduce.input.keyvaluelinerecordreader.key.value.separator. The default
- separator is the tab character ('\t').]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.KeyValueLineRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.KeyValueTextInputFormat -->
- <class name="KeyValueTextInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KeyValueTextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
- Either line feed or carriage-return are used to signal end of line.
- Each line is divided into key and value parts by a separator byte. If no
- such a byte exists, the key will be the entire line and value will be empty.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.KeyValueTextInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.LineRecordReader -->
- <class name="LineRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LineRecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.io.LongWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCurrentValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the progress within the split]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Treats keys as offset in file and value as line.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.LineRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.MultipleInputs -->
- <class name="MultipleInputs" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleInputs"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="inputFormatClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a {@link Path} with a custom {@link InputFormat} to the list of
- inputs for the map-reduce job.
-
- @param job The {@link Job}
- @param path {@link Path} to be added to the list of inputs for the job
- @param inputFormatClass {@link InputFormat} class to use for this path]]>
- </doc>
- </method>
- <method name="addInputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="inputFormatClass" type="java.lang.Class"/>
- <param name="mapperClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Add a {@link Path} with a custom {@link InputFormat} and
- {@link Mapper} to the list of inputs for the map-reduce job.
-
- @param job The {@link Job}
- @param path {@link Path} to be added to the list of inputs for the job
- @param inputFormatClass {@link InputFormat} class to use for this path
- @param mapperClass {@link Mapper} class to use for this path]]>
- </doc>
- </method>
- <field name="DIR_FORMATS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DIR_MAPPERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class supports MapReduce jobs that have multiple input paths with
- a different {@link InputFormat} and {@link Mapper} for each path]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.MultipleInputs -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.NLineInputFormat -->
- <class name="NLineInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NLineInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="genericSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Logically splits the set of input files for the job, splits N lines
- of the input as one split.
-
- @see FileInputFormat#getSplits(JobContext)]]>
- </doc>
- </method>
- <method name="getSplitsForFile" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="numLinesPerSplit" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="createFileSplit" return="org.apache.hadoop.mapreduce.lib.input.FileSplit"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="fileName" type="org.apache.hadoop.fs.Path"/>
- <param name="begin" type="long"/>
- <param name="length" type="long"/>
- <doc>
- <![CDATA[NLineInputFormat uses LineRecordReader, which always reads
- (and consumes) at least one character out of its upper split
- boundary. So to make sure that each mapper gets N lines, we
- move back the upper split limits of each split
- by one character here.
- @param fileName Path of file
- @param begin the position of the first byte in the file to process
- @param length number of bytes in InputSplit
- @return FileSplit]]>
- </doc>
- </method>
- <method name="setNumLinesPerSplit"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="numLines" type="int"/>
- <doc>
- <![CDATA[Set the number of lines per split
- @param job the job to modify
- @param numLines the number of lines per split]]>
- </doc>
- </method>
- <method name="getNumLinesPerSplit" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the number of lines per split
- @param job the job
- @return the number of lines per split]]>
- </doc>
- </method>
- <field name="LINES_PER_MAP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[NLineInputFormat which splits N lines of input as one split.
- In many "pleasantly" parallel applications, each process/mapper
- processes the same input file (s), but with computations are
- controlled by different parameters.(Referred to as "parameter sweeps").
- One way to achieve this, is to specify a set of parameters
- (one set per line) as input in a control file
- (which is the input path to the map-reduce application,
- where as the input dataset is specified
- via a config variable in JobConf.).
-
- The NLineInputFormat can be used in such applications, that splits
- the input file such that by default, one line is fed as
- a value to one map task, and key is the offset.
- i.e. (k,v) is (LongWritable, Text).
- The location hints will span the whole mapred cluster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.NLineInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsBinaryInputFormat -->
- <class name="SequenceFileAsBinaryInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsBinaryInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[InputFormat reading keys, values from SequenceFiles in binary (raw)
- format.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsBinaryInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
- <class name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.io.BytesWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentValue" return="org.apache.hadoop.io.BytesWritable"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getKeyClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the name of the key class for this SequenceFile.
- @see org.apache.hadoop.io.SequenceFile.Reader#getKeyClassName]]>
- </doc>
- </method>
- <method name="getValueClassName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the name of the value class for this SequenceFile.
- @see org.apache.hadoop.io.SequenceFile.Reader#getValueClassName]]>
- </doc>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Read raw bytes from a SequenceFile.]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Return the progress within the input split
- @return 0.0 to 1.0 of the input byte range]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Read records from a SequenceFile as binary (raw) bytes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsTextInputFormat -->
- <class name="SequenceFileAsTextInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsTextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class is similar to SequenceFileInputFormat, except it generates
- SequenceFileAsTextRecordReader which converts the input keys and values
- to their String forms by calling toString() method.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsTextInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsTextRecordReader -->
- <class name="SequenceFileAsTextRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsTextRecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentKey" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentValue" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Read key/value pair in a line.]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This class converts the input keys and values to their String forms by
- calling toString() method. This class to SequenceFileAsTextInputFormat
- class is as LineRecordReader class to TextInputFormat class.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileAsTextRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter -->
- <class name="SequenceFileInputFilter" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a record reader for the given split
- @param split file split
- @param context the task-attempt context
- @return RecordReader]]>
- </doc>
- </method>
- <method name="setFilterClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="filterClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[set the filter class
-
- @param job The job
- @param filterClass filter class]]>
- </doc>
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILTER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILTER_FREQUENCY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILTER_REGEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A class that allows a map/red job to work on a sample of sequence files.
- The sample is decided by the filter class set by the job.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter -->
- <!-- start interface org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.Filter -->
- <interface name="SequenceFileInputFilter.Filter" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[filter function
- Decide if a record should be filtered or not
- @param key record key
- @return true if a record is accepted; return false otherwise]]>
- </doc>
- </method>
- <doc>
- <![CDATA[filter interface]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.Filter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.FilterBase -->
- <class name="SequenceFileInputFilter.FilterBase" extends="java.lang.Object"
- abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.Filter"/>
- <constructor name="SequenceFileInputFilter.FilterBase"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[base class for Filters]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.FilterBase -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.MD5Filter -->
- <class name="SequenceFileInputFilter.MD5Filter" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.MD5Filter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setFrequency"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="frequency" type="int"/>
- <doc>
- <![CDATA[set the filtering frequency in configuration
-
- @param conf configuration
- @param frequency filtering frequency]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the filter according to configuration
-
- @param conf configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If MD5(key) % frequency==0, return true; otherwise return false
- @see Filter#accept(Object)]]>
- </doc>
- </method>
- <field name="MD5_LEN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class returns a set of records by examing the MD5 digest of its
- key against a filtering frequency <i>f</i>. The filtering criteria is
- MD5(key) % f == 0.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.MD5Filter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.PercentFilter -->
- <class name="SequenceFileInputFilter.PercentFilter" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.PercentFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setFrequency"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="frequency" type="int"/>
- <doc>
- <![CDATA[set the frequency and stores it in conf
- @param conf configuration
- @param frequency filtering frequencey]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the filter by checking the configuration
-
- @param conf configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If record# % frequency==0, return true; otherwise return false
- @see Filter#accept(Object)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class returns a percentage of records
- The percentage is determined by a filtering frequency <i>f</i> using
- the criteria record# % f == 0.
- For example, if the frequency is 10, one out of 10 records is returned.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.PercentFilter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.RegexFilter -->
- <class name="SequenceFileInputFilter.RegexFilter" extends="org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.FilterBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFilter.RegexFilter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setPattern"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="regex" type="java.lang.String"/>
- <exception name="PatternSyntaxException" type="java.util.regex.PatternSyntaxException"/>
- <doc>
- <![CDATA[Define the filtering regex and stores it in conf
- @param conf where the regex is set
- @param regex regex used as a filter]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[configure the Filter by checking the configuration]]>
- </doc>
- </method>
- <method name="accept" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <doc>
- <![CDATA[Filtering method
- If key matches the regex, return true; otherwise return false
- @see Filter#accept(Object)]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Records filter by matching key to regex]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFilter.RegexFilter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat -->
- <class name="SequenceFileInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getFormatMinSplitSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="listStatus" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileRecordReader -->
- <class name="SequenceFileRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileRecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Return the progress within the input split
- @return 0.0 to 1.0 of the input byte range]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="conf" type="org.apache.hadoop.conf.Configuration"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An {@link RecordReader} for {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileRecordReader -->
- <!-- start class org.apache.hadoop.mapreduce.lib.input.TextInputFormat -->
- <class name="TextInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TextInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- </method>
- <method name="isSplitable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="file" type="org.apache.hadoop.fs.Path"/>
- </method>
- <doc>
- <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
- Either linefeed or carriage-return are used to signal end of line. Keys are
- the position in the file, and values are the line of text..]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.input.TextInputFormat -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.jobcontrol">
- <!-- start class org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob -->
- <class name="ControlledJob" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ControlledJob" type="org.apache.hadoop.mapreduce.Job, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a job.
- @param job a mapreduce job to be executed.
- @param dependingJobs an array of jobs the current job depends on]]>
- </doc>
- </constructor>
- <constructor name="ControlledJob" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a job.
-
- @param conf mapred job configuration representing a job to be executed.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job name of this job]]>
- </doc>
- </method>
- <method name="setJobName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the job name for this job.
- @param jobName the job name]]>
- </doc>
- </method>
- <method name="getJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job ID of this job assigned by JobControl]]>
- </doc>
- </method>
- <method name="setJobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the job ID for this job.
- @param id the job ID]]>
- </doc>
- </method>
- <method name="getMapredJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the mapred ID of this job as assigned by the
- mapred framework.]]>
- </doc>
- </method>
- <method name="getJob" return="org.apache.hadoop.mapreduce.Job"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the mapreduce job]]>
- </doc>
- </method>
- <method name="setJob"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <doc>
- <![CDATA[Set the mapreduce job
- @param job the mapreduce job for this job.]]>
- </doc>
- </method>
- <method name="getJobState" return="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the state of this job]]>
- </doc>
- </method>
- <method name="setJobState"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="state" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"/>
- <doc>
- <![CDATA[Set the state for this job.
- @param state the new state for this job.]]>
- </doc>
- </method>
- <method name="getMessage" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the message of this job]]>
- </doc>
- </method>
- <method name="setMessage"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="message" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the message for this job.
- @param message the message for this job.]]>
- </doc>
- </method>
- <method name="getDependentJobs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the depending jobs of this job]]>
- </doc>
- </method>
- <method name="addDependingJob" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="dependingJob" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob"/>
- <doc>
- <![CDATA[Add a job to this jobs' dependency list.
- Dependent jobs can only be added while a Job
- is waiting to run, not during or afterwards.
-
- @param dependingJob Job that this Job depends on.
- @return <tt>true</tt> if the Job was added.]]>
- </doc>
- </method>
- <method name="isCompleted" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this job is in a complete state]]>
- </doc>
- </method>
- <method name="isReady" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if this job is in READY state]]>
- </doc>
- </method>
- <method name="killJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="failJob"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="message" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="submit"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Submit this job to mapred. The state becomes RUNNING if submission
- is successful, FAILED otherwise.]]>
- </doc>
- </method>
- <field name="CREATE_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class encapsulates a MapReduce job and its dependency. It monitors
- the states of the depending jobs and updates the state of this job.
- A job starts in the WAITING state. If it does not have any depending jobs,
- or all of the depending jobs are in SUCCESS state, then the job state
- will become READY. If any depending jobs fail, the job will fail too.
- When in READY state, the job can be submitted to Hadoop for execution, with
- the state changing into RUNNING state. From RUNNING state, the job
- can get into SUCCESS or FAILED state, depending
- the status of the job execution.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob -->
- <!-- start class org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State -->
- <class name="ControlledJob.State" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SUCCESS" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="WAITING" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READY" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEPENDENT_FAILED" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob.State -->
- <!-- start class org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl -->
- <class name="JobControl" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Runnable"/>
- <constructor name="JobControl" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a job control for a group of jobs.
- @param groupName a name identifying this group]]>
- </doc>
- </constructor>
- <method name="getWaitingJobList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the waiting state]]>
- </doc>
- </method>
- <method name="getRunningJobList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the running state]]>
- </doc>
- </method>
- <method name="getReadyJobsList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the ready state]]>
- </doc>
- </method>
- <method name="getSuccessfulJobList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the jobs in the success state]]>
- </doc>
- </method>
- <method name="getFailedJobList" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addJob" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="aJob" type="org.apache.hadoop.mapreduce.lib.jobcontrol.ControlledJob"/>
- <doc>
- <![CDATA[Add a new job.
- @param aJob the new job]]>
- </doc>
- </method>
- <method name="addJobCollection"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobs" type="java.util.Collection"/>
- <doc>
- <![CDATA[Add a collection of jobs
-
- @param jobs]]>
- </doc>
- </method>
- <method name="getThreadState" return="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the thread state]]>
- </doc>
- </method>
- <method name="stop"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[set the thread state to STOPPING so that the
- thread will stop when it wakes up.]]>
- </doc>
- </method>
- <method name="suspend"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[suspend the running thread]]>
- </doc>
- </method>
- <method name="resume"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[resume the suspended thread]]>
- </doc>
- </method>
- <method name="allFinished" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The main loop for the thread.
- The loop does the following:
- Check the states of the running jobs
- Update the states of waiting jobs
- Submit the jobs in ready state]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class encapsulates a set of MapReduce jobs and its dependency.
-
- It tracks the states of the jobs by placing them into different tables
- according to their states.
-
- This class provides APIs for the client app to add a job to the group
- and to get the jobs in the group in different states. When a job is
- added, an ID unique to the group is assigned to the job.
-
- This class has a thread that submits jobs when they become ready,
- monitors the states of the running jobs, and updates the states of jobs
- based on the state changes of their depending jobs states. The class
- provides APIs for suspending/resuming the thread, and
- for stopping the thread.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl -->
- <!-- start class org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState -->
- <class name="JobControl.ThreadState" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="RUNNING" type="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SUSPENDED" type="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STOPPED" type="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STOPPING" type="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="READY" type="org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.jobcontrol.JobControl.ThreadState -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.map">
- <!-- start class org.apache.hadoop.mapreduce.lib.map.InverseMapper -->
- <class name="InverseMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InverseMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[The inverse function. Input keys and values are swapped.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A {@link Mapper} that swaps keys and values.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.map.InverseMapper -->
- <!-- start class org.apache.hadoop.mapreduce.lib.map.MultithreadedMapper -->
- <class name="MultithreadedMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultithreadedMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumberOfThreads" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[The number of threads in the thread pool that will run the map function.
- @param job the job
- @return the number of threads]]>
- </doc>
- </method>
- <method name="setNumberOfThreads"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="threads" type="int"/>
- <doc>
- <![CDATA[Set the number of threads in the pool for running maps.
- @param job the job to modify
- @param threads the new number of threads]]>
- </doc>
- </method>
- <method name="getMapperClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the application's mapper class.
- @param <K1> the map's input key type
- @param <V1> the map's input value type
- @param <K2> the map's output key type
- @param <V2> the map's output value type
- @param job the job
- @return the mapper class to run]]>
- </doc>
- </method>
- <method name="setMapperClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="cls" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the application's mapper class.
- @param <K1> the map input key type
- @param <V1> the map input value type
- @param <K2> the map output key type
- @param <V2> the map output value type
- @param job the job to modify
- @param cls the class to use as the mapper]]>
- </doc>
- </method>
- <method name="run"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Run the application's maps using a thread pool.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Multithreaded implementation for @link org.apache.hadoop.mapreduce.Mapper.
- <p>
- It can be used instead of the default implementation,
- @link org.apache.hadoop.mapred.MapRunner, when the Map operation is not CPU
- bound in order to improve throughput.
- <p>
- Mapper implementations using this MapRunnable must be thread-safe.
- <p>
- The Map-Reduce job has to be configured with the mapper to use via
- {@link #setMapperClass(Configuration, Class)} and
- the number of thread the thread-pool can use with the
- {@link #getNumberOfThreads(Configuration) method. The default
- value is 10 threads.
- <p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.map.MultithreadedMapper -->
- <!-- start class org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper -->
- <class name="TokenCounterMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TokenCounterMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[Tokenize the input values and emit each word with a count of 1.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.output">
- <!-- start class org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter -->
- <class name="FileOutputCommitter" extends="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileOutputCommitter" type="org.apache.hadoop.fs.Path, org.apache.hadoop.mapreduce.TaskAttemptContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a file output committer
- @param outputPath the job's output path
- @param context the task's context
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="setupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the temporary directory that is the root of all of the task
- work directories.
- @param context the job's context]]>
- </doc>
- </method>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the temporary directory, including all of the work directories.
- This is called for all jobs whose final run state is SUCCEEDED
- @param context the job's context.]]>
- </doc>
- </method>
- <method name="cleanupJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="state" type="org.apache.hadoop.mapreduce.JobStatus.State"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Delete the temporary directory, including all of the work directories.
- @param context the job's context
- @param state final run state of the job, should be FAILED or KILLED]]>
- </doc>
- </method>
- <method name="setupTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[No task setup required.]]>
- </doc>
- </method>
- <method name="commitTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move the files from the work directory to the job output directory
- @param context the task context]]>
- </doc>
- </method>
- <method name="abortTask"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <doc>
- <![CDATA[Delete the work directory]]>
- </doc>
- </method>
- <method name="needsTaskCommit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Did this task write any files in the work directory?
- @param context the task's context]]>
- </doc>
- </method>
- <method name="getWorkPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the directory that the task should write results into
- @return the work directory
- @throws IOException]]>
- </doc>
- </method>
- <field name="TEMP_DIR_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Temporary directory name]]>
- </doc>
- </field>
- <field name="SUCCEEDED_FILE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An {@link OutputCommitter} that commits files specified
- in job output directory i.e. ${mapred.output.dir}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat -->
- <class name="FileOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setCompressOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="compress" type="boolean"/>
- <doc>
- <![CDATA[Set whether the output of the job is compressed.
- @param job the job to modify
- @param compress should the output of the job be compressed?]]>
- </doc>
- </method>
- <method name="getCompressOutput" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Is the job output compressed?
- @param job the Job to look in
- @return <code>true</code> if the job output should be compressed,
- <code>false</code> otherwise]]>
- </doc>
- </method>
- <method name="setOutputCompressorClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="codecClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the {@link CompressionCodec} to be used to compress job outputs.
- @param job the job to modify
- @param codecClass the {@link CompressionCodec} to be used to
- compress the job outputs]]>
- </doc>
- </method>
- <method name="getOutputCompressorClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="defaultValue" type="java.lang.Class"/>
- <doc>
- <![CDATA[Get the {@link CompressionCodec} for compressing the job outputs.
- @param job the {@link Job} to look in
- @param defaultValue the {@link CompressionCodec} to return if not set
- @return the {@link CompressionCodec} to be used to compress the
- job outputs
- @throws IllegalArgumentException if the class was specified, but not found]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="FileAlreadyExistsException" type="org.apache.hadoop.mapred.FileAlreadyExistsException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="setOutputPath"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="outputDir" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the {@link Path} of the output directory for the map-reduce job.
- @param job The job to modify
- @param outputDir the {@link Path} of the output directory for
- the map-reduce job.]]>
- </doc>
- </method>
- <method name="getOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the {@link Path} to the output directory for the map-reduce job.
-
- @return the {@link Path} to the output directory for the map-reduce job.
- @see FileOutputFormat#getWorkOutputPath(TaskInputOutputContext)]]>
- </doc>
- </method>
- <method name="getWorkOutputPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskInputOutputContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Get the {@link Path} to the task's temporary output directory
- for the map-reduce job
-
- <h4 id="SideEffectFiles">Tasks' Side-Effect Files</h4>
-
- <p>Some applications need to create/write-to side-files, which differ from
- the actual job-outputs.
-
- <p>In such cases there could be issues with 2 instances of the same TIP
- (running simultaneously e.g. speculative tasks) trying to open/write-to the
- same file (path) on HDFS. Hence the application-writer will have to pick
- unique names per task-attempt (e.g. using the attemptid, say
- <tt>attempt_200709221812_0001_m_000000_0</tt>), not just per TIP.</p>
-
- <p>To get around this the Map-Reduce framework helps the application-writer
- out by maintaining a special
- <tt>${mapred.output.dir}/_temporary/_${taskid}</tt>
- sub-directory for each task-attempt on HDFS where the output of the
- task-attempt goes. On successful completion of the task-attempt the files
- in the <tt>${mapred.output.dir}/_temporary/_${taskid}</tt> (only)
- are <i>promoted</i> to <tt>${mapred.output.dir}</tt>. Of course, the
- framework discards the sub-directory of unsuccessful task-attempts. This
- is completely transparent to the application.</p>
-
- <p>The application-writer can take advantage of this by creating any
- side-files required in a work directory during execution
- of his task i.e. via
- {@link #getWorkOutputPath(TaskInputOutputContext)}, and
- the framework will move them out similarly - thus she doesn't have to pick
- unique paths per task-attempt.</p>
-
- <p>The entire discussion holds true for maps of jobs with
- reducer=NONE (i.e. 0 reduces) since output of the map, in that case,
- goes directly to HDFS.</p>
-
- @return the {@link Path} to the task's temporary output directory
- for the map-reduce job.]]>
- </doc>
- </method>
- <method name="getPathForWorkFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskInputOutputContext"/>
- <param name="name" type="java.lang.String"/>
- <param name="extension" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Helper function to generate a {@link Path} for a file that is unique for
- the task within the job output directory.
- <p>The path can be used to create custom files from within the map and
- reduce tasks. The path name will be unique for each task. The path parent
- will be the job output directory.</p>ls
- <p>This method uses the {@link #getUniqueFile} method to make the file name
- unique for the task.</p>
- @param context the context for the task.
- @param name the name for the file.
- @param extension the extension for the file
- @return a unique path accross all tasks of the job.]]>
- </doc>
- </method>
- <method name="getUniqueFile" return="java.lang.String"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <param name="name" type="java.lang.String"/>
- <param name="extension" type="java.lang.String"/>
- <doc>
- <![CDATA[Generate a unique filename, based on the task id, name, and extension
- @param context the task that is calling this
- @param name the base filename
- @param extension the filename extension
- @return a string like $name-[mr]-$id$extension]]>
- </doc>
- </method>
- <method name="getDefaultWorkFile" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <param name="extension" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the default path and filename for the output format.
- @param context the task context
- @param extension an extension to add to the filename
- @return a full path $output/_temporary/$taskid/part-[mr]-$id
- @throws IOException]]>
- </doc>
- </method>
- <method name="getOutputName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the base output name for the output file.]]>
- </doc>
- </method>
- <method name="setOutputName"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the base output name for output file to be created.]]>
- </doc>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="BASE_OUTPUT_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="PART" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A base class for {@link OutputFormat}s that read from {@link FileSystem}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat.Counter -->
- <class name="FileOutputFormat.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="BYTES_WRITTEN" type="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat.Counter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.FilterOutputFormat -->
- <class name="FilterOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FilterOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FilterOutputFormat" type="org.apache.hadoop.mapreduce.OutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a FilterOutputFormat based on the underlying output format.
- @param baseOut the underlying OutputFormat]]>
- </doc>
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="baseOut" type="org.apache.hadoop.mapreduce.OutputFormat"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[FilterOutputFormat is a convenience class that wraps OutputFormat.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.FilterOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.FilterOutputFormat.FilterRecordWriter -->
- <class name="FilterOutputFormat.FilterRecordWriter" extends="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FilterOutputFormat.FilterRecordWriter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FilterOutputFormat.FilterRecordWriter" type="org.apache.hadoop.mapreduce.RecordWriter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="rawWriter" type="org.apache.hadoop.mapreduce.RecordWriter"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<code>FilterRecordWriter</code> is a convenience wrapper
- class that extends the {@link RecordWriter}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.FilterOutputFormat.FilterRecordWriter -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.LazyOutputFormat -->
- <class name="LazyOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.FilterOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LazyOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setOutputFormatClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the underlying output format for LazyOutputFormat.
- @param job the {@link Job} to modify
- @param theClass the underlying class]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <field name="OUTPUT_FORMAT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Convenience class that creates output lazily.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.LazyOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.MultipleOutputs -->
- <class name="MultipleOutputs" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MultipleOutputs" type="org.apache.hadoop.mapreduce.TaskInputOutputContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Creates and initializes multiple outputs support,
- it should be instantiated in the Mapper/Reducer setup method.
- @param context the TaskInputOutputContext object]]>
- </doc>
- </constructor>
- <method name="addNamedOutput"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="namedOutput" type="java.lang.String"/>
- <param name="outputFormatClass" type="java.lang.Class"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Adds a named output for the job.
- <p/>
- @param job job to add the named output
- @param namedOutput named output name, it has to be a word, letters
- and numbers only, cannot be the word 'part' as
- that is reserved for the default output.
- @param outputFormatClass OutputFormat class.
- @param keyClass key class
- @param valueClass value class]]>
- </doc>
- </method>
- <method name="setCountersEnabled"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="enabled" type="boolean"/>
- <doc>
- <![CDATA[Enables or disables counters for the named outputs.
-
- The counters group is the {@link MultipleOutputs} class name.
- The names of the counters are the same as the named outputs. These
- counters count the number records written to each output name.
- By default these counters are disabled.
- @param job job to enable counters
- @param enabled indicates if the counters will be enabled or not.]]>
- </doc>
- </method>
- <method name="getCountersEnabled" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Returns if the counters for the named outputs are enabled or not.
- By default these counters are disabled.
- @param job the job
- @return TRUE if the counters are enabled, FALSE if they are disabled.]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="namedOutput" type="java.lang.String"/>
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Write key and value to the namedOutput.
- Output path is a unique file generated for the namedOutput.
- For example, {namedOutput}-(m|r)-{part-number}
-
- @param namedOutput the named output name
- @param key the key
- @param value the value]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="namedOutput" type="java.lang.String"/>
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="baseOutputPath" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Write key and value to baseOutputPath using the namedOutput.
-
- @param namedOutput the named output name
- @param key the key
- @param value the value
- @param baseOutputPath base-output path to write the record to.
- Note: Framework will generate unique filename for the baseOutputPath]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="baseOutputPath" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Write key value to an output file name.
-
- Gets the record writer from job's output format.
- Job's output format should be a FileOutputFormat.
-
- @param key the key
- @param value the value
- @param baseOutputPath base-output path to write the record to.
- Note: Framework will generate unique filename for the baseOutputPath]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Closes all the opened outputs.
-
- This should be called from cleanup method of map/reduce task.
- If overridden subclasses must invoke <code>super.close()</code> at the
- end of their <code>close()</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The MultipleOutputs class simplifies writing output data
- to multiple outputs
-
- <p>
- Case one: writing to additional outputs other than the job default output.
- Each additional output, or named output, may be configured with its own
- <code>OutputFormat</code>, with its own key class and with its own value
- class.
-
- <p>
- Case two: to write data to different files provided by user
- </p>
-
- <p>
- MultipleOutputs supports counters, by default they are disabled. The
- counters group is the {@link MultipleOutputs} class name. The names of the
- counters are the same as the output name. These count the number records
- written to each output name.
- </p>
-
- Usage pattern for job submission:
- <pre>
- Job job = new Job();
- FileInputFormat.setInputPath(job, inDir);
- FileOutputFormat.setOutputPath(job, outDir);
- job.setMapperClass(MOMap.class);
- job.setReducerClass(MOReduce.class);
- ...
- // Defines additional single text based output 'text' for the job
- MultipleOutputs.addNamedOutput(job, "text", TextOutputFormat.class,
- LongWritable.class, Text.class);
- // Defines additional sequence-file based output 'sequence' for the job
- MultipleOutputs.addNamedOutput(job, "seq",
- SequenceFileOutputFormat.class,
- LongWritable.class, Text.class);
- ...
- job.waitForCompletion(true);
- ...
- </pre>
- <p>
- Usage in Reducer:
- <pre>
- <K, V> String generateFileName(K k, V v) {
- return k.toString() + "_" + v.toString();
- }
-
- public class MOReduce extends
- Reducer<WritableComparable, Writable,WritableComparable, Writable> {
- private MultipleOutputs mos;
- public void setup(Context context) {
- ...
- mos = new MultipleOutputs(context);
- }
- public void reduce(WritableComparable key, Iterator<Writable> values,
- Context context)
- throws IOException {
- ...
- mos.write("text", , key, new Text("Hello"));
- mos.write("seq", LongWritable(1), new Text("Bye"), "seq_a");
- mos.write("seq", LongWritable(2), key, new Text("Chau"), "seq_b");
- mos.write(key, new Text("value"), generateFileName(key, new Text("value")));
- ...
- }
- public void cleanup(Context) throws IOException {
- mos.close();
- ...
- }
- }
- </pre>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.MultipleOutputs -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.NullOutputFormat -->
- <class name="NullOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NullOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- </method>
- <doc>
- <![CDATA[Consume all outputs and put them in /dev/null.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.NullOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.SequenceFileAsBinaryOutputFormat -->
- <class name="SequenceFileAsBinaryOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileAsBinaryOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setSequenceFileOutputKeyClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the key class for the {@link SequenceFile}
- <p>This allows the user to specify the key class to be different
- from the actual class ({@link BytesWritable}) used for writing </p>
-
- @param job the {@link Job} to modify
- @param theClass the SequenceFile output key class.]]>
- </doc>
- </method>
- <method name="setSequenceFileOutputValueClass"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="theClass" type="java.lang.Class"/>
- <doc>
- <![CDATA[Set the value class for the {@link SequenceFile}
- <p>This allows the user to specify the value class to be different
- from the actual class ({@link BytesWritable}) used for writing </p>
-
- @param job the {@link Job} to modify
- @param theClass the SequenceFile output key class.]]>
- </doc>
- </method>
- <method name="getSequenceFileOutputKeyClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the key class for the {@link SequenceFile}
-
- @return the key class of the {@link SequenceFile}]]>
- </doc>
- </method>
- <method name="getSequenceFileOutputValueClass" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the value class for the {@link SequenceFile}
-
- @return the value class of the {@link SequenceFile}]]>
- </doc>
- </method>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSequenceWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <param name="keyClass" type="java.lang.Class"/>
- <param name="valueClass" type="java.lang.Class"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="KEY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VALUE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[An {@link org.apache.hadoop.mapreduce.OutputFormat} that writes keys,
- values to {@link SequenceFile}s in binary(raw) format]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.SequenceFileAsBinaryOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
- <class name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
- <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" type="org.apache.hadoop.io.BytesWritable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reset"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="org.apache.hadoop.io.BytesWritable"/>
- </method>
- <method name="writeUncompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="writeCompressedBytes"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="outStream" type="java.io.DataOutputStream"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getSize" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Inner class used for appendRaw]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat -->
- <class name="SequenceFileOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SequenceFileOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="getOutputCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the {@link CompressionType} for the output {@link SequenceFile}.
- @param job the {@link Job}
- @return the {@link CompressionType} for the output {@link SequenceFile},
- defaulting to {@link CompressionType#RECORD}]]>
- </doc>
- </method>
- <method name="setOutputCompressionType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="style" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
- <doc>
- <![CDATA[Set the {@link CompressionType} for the output {@link SequenceFile}.
- @param job the {@link Job} to modify
- @param style the {@link CompressionType} for the output
- {@link SequenceFile}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes {@link SequenceFile}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat -->
- <class name="TextOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TextOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <doc>
- <![CDATA[An {@link OutputFormat} that writes plain text files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat -->
- <!-- start class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat.LineRecordWriter -->
- <class name="TextOutputFormat.LineRecordWriter" extends="org.apache.hadoop.mapreduce.RecordWriter"
- abstract="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <field name="out" type="java.io.DataOutputStream"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat.LineRecordWriter -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.partition">
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.BinaryPartitioner -->
- <class name="BinaryPartitioner" extends="org.apache.hadoop.mapreduce.Partitioner"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="BinaryPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setOffsets"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="left" type="int"/>
- <param name="right" type="int"/>
- <doc>
- <![CDATA[Set the subarray to be used for partitioning to
- <code>bytes[left:(right+1)]</code> in Python syntax.
-
- @param conf configuration object
- @param left left Python-style offset
- @param right right Python-style offset]]>
- </doc>
- </method>
- <method name="setLeftOffset"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="offset" type="int"/>
- <doc>
- <![CDATA[Set the subarray to be used for partitioning to
- <code>bytes[offset:]</code> in Python syntax.
-
- @param conf configuration object
- @param offset left Python-style offset]]>
- </doc>
- </method>
- <method name="setRightOffset"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="offset" type="int"/>
- <doc>
- <![CDATA[Set the subarray to be used for partitioning to
- <code>bytes[:(offset+1)]</code> in Python syntax.
-
- @param conf configuration object
- @param offset right Python-style offset]]>
- </doc>
- </method>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.BinaryComparable"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numPartitions" type="int"/>
- <doc>
- <![CDATA[Use (the specified slice of the array returned by)
- {@link BinaryComparable#getBytes()} to partition.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>Partition {@link BinaryComparable} keys using a configurable part of
- the bytes array returned by {@link BinaryComparable#getBytes()}.</p>
-
- <p>The subarray to be used for the partitioning can be defined by means
- of the following properties:
- <ul>
- <li>
- <i>mapred.binary.partitioner.left.offset</i>:
- left offset in array (0 by default)
- </li>
- <li>
- <i>mapred.binary.partitioner.right.offset</i>:
- right offset in array (-1 by default)
- </li>
- </ul>
- Like in Python, both negative and positive offsets are allowed, but
- the meaning is slightly different. In case of an array of length 5,
- for instance, the possible offsets are:
- <pre><code>
- +---+---+---+---+---+
- | B | B | B | B | B |
- +---+---+---+---+---+
- 0 1 2 3 4
- -5 -4 -3 -2 -1
- </code></pre>
- The first row of numbers gives the position of the offsets 0...5 in
- the array; the second row gives the corresponding negative offsets.
- Contrary to Python, the specified subarray has byte <code>i</code>
- and <code>j</code> as first and last element, repectively, when
- <code>i</code> and <code>j</code> are the left and right offset.
-
- <p>For Hadoop programs written in Java, it is advisable to use one of
- the following static convenience methods for setting the offsets:
- <ul>
- <li>{@link #setOffsets}</li>
- <li>{@link #setLeftOffset}</li>
- <li>{@link #setRightOffset}</li>
- </ul></p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.BinaryPartitioner -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.HashPartitioner -->
- <class name="HashPartitioner" extends="org.apache.hadoop.mapreduce.Partitioner"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="HashPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numReduceTasks" type="int"/>
- <doc>
- <![CDATA[Use {@link Object#hashCode()} to partition.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Partition keys by their {@link Object#hashCode()}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.HashPartitioner -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.InputSampler -->
- <class name="InputSampler" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="InputSampler" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="writePartitionFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="sampler" type="org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Write a partition file for the given job, using the Sampler provided.
- Queries the sampler for a sample keyset, sorts by the output key
- comparator, selects the keys for each rank, and writes to the destination
- returned from {@link TotalOrderPartitioner#getPartitionFile}.]]>
- </doc>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Driver for InputSampler from the command line.
- Configures a JobConf instance and calls {@link #writePartitionFile}.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[Utility for collecting samples and writing a partition file for
- {@link TotalOrderPartitioner}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.InputSampler -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.InputSampler.IntervalSampler -->
- <class name="InputSampler.IntervalSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler"/>
- <constructor name="InputSampler.IntervalSampler" type="double"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new IntervalSampler sampling <em>all</em> splits.
- @param freq The frequency with which records will be emitted.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.IntervalSampler" type="double, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new IntervalSampler.
- @param freq The frequency with which records will be emitted.
- @param maxSplitsSampled The maximum number of splits to examine.
- @see #getSample]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapreduce.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[For each split sampled, emit when the ratio of the number of records
- retained to the total record count is less than the specified
- frequency.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Sample from s splits at regular intervals.
- Useful for sorted data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.InputSampler.IntervalSampler -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.InputSampler.RandomSampler -->
- <class name="InputSampler.RandomSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler"/>
- <constructor name="InputSampler.RandomSampler" type="double, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new RandomSampler sampling <em>all</em> splits.
- This will read every split at the client, which is very expensive.
- @param freq Probability with which a key will be chosen.
- @param numSamples Total number of samples to obtain from all selected
- splits.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.RandomSampler" type="double, int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new RandomSampler.
- @param freq Probability with which a key will be chosen.
- @param numSamples Total number of samples to obtain from all selected
- splits.
- @param maxSplitsSampled The maximum number of splits to examine.]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapreduce.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Randomize the split order, then take the specified number of keys from
- each split sampled, where each key is selected with the specified
- probability and possibly replaced by a subsequently selected key when
- the quota of keys from that split is satisfied.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Sample from random points in the input.
- General-purpose sampler. Takes numSamples / maxSplitsSampled inputs from
- each split.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.InputSampler.RandomSampler -->
- <!-- start interface org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler -->
- <interface name="InputSampler.Sampler" abstract="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapreduce.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[For a given job, collect and return a subset of the keys from the
- input data.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface to sample using an
- {@link org.apache.hadoop.mapreduce.InputFormat}.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.InputSampler.SplitSampler -->
- <class name="InputSampler.SplitSampler" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapreduce.lib.partition.InputSampler.Sampler"/>
- <constructor name="InputSampler.SplitSampler" type="int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a SplitSampler sampling <em>all</em> splits.
- Takes the first numSamples / numSplits records from each split.
- @param numSamples Total number of samples to obtain from all selected
- splits.]]>
- </doc>
- </constructor>
- <constructor name="InputSampler.SplitSampler" type="int, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new SplitSampler.
- @param numSamples Total number of samples to obtain from all selected
- splits.
- @param maxSplitsSampled The maximum number of splits to examine.]]>
- </doc>
- </constructor>
- <method name="getSample" return="java.lang.Object[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inf" type="org.apache.hadoop.mapreduce.InputFormat"/>
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[From each split sampled, take the first numSamples / numSplits records.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Samples the first n records from s splits.
- Inexpensive way to sample random data.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.InputSampler.SplitSampler -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.KeyFieldBasedComparator -->
- <class name="KeyFieldBasedComparator" extends="org.apache.hadoop.io.WritableComparator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="KeyFieldBasedComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <method name="setKeyFieldComparatorOptions"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="keySpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the {@link KeyFieldBasedComparator} options used to compare keys.
-
- @param keySpec the key specification of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field). opts are ordering options. The supported options
- are:
- -n, (Sort numerically)
- -r, (Reverse the result of comparison)]]>
- </doc>
- </method>
- <method name="getKeyFieldComparatorOption" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the {@link KeyFieldBasedComparator} options]]>
- </doc>
- </method>
- <field name="COMPARATOR_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This comparator implementation provides a subset of the features provided
- by the Unix/GNU Sort. In particular, the supported features are:
- -n, (Sort numerically)
- -r, (Reverse the result of comparison)
- -k pos1[,pos2], where pos is of the form f[.c][opts], where f is the number
- of the field to use, and c is the number of the first character from the
- beginning of the field. Fields and character posns are numbered starting
- with 1; a character position of zero in pos2 indicates the field's last
- character. If '.c' is omitted from pos1, it defaults to 1 (the beginning
- of the field); if omitted from pos2, it defaults to 0 (the end of the
- field). opts are ordering options (any of 'nr' as described above).
- We assume that the fields in the key are separated by
- mapreduce.map.output.key.field.separator.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.KeyFieldBasedComparator -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.KeyFieldBasedPartitioner -->
- <class name="KeyFieldBasedPartitioner" extends="org.apache.hadoop.mapreduce.Partitioner"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="KeyFieldBasedPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numReduceTasks" type="int"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="start" type="int"/>
- <param name="end" type="int"/>
- <param name="currentHash" type="int"/>
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="hash" type="int"/>
- <param name="numReduceTasks" type="int"/>
- </method>
- <method name="setKeyFieldPartitionerOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="keySpec" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the {@link KeyFieldBasedPartitioner} options used for
- {@link Partitioner}
-
- @param keySpec the key specification of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field).]]>
- </doc>
- </method>
- <method name="getKeyFieldPartitionerOption" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
- <doc>
- <![CDATA[Get the {@link KeyFieldBasedPartitioner} options]]>
- </doc>
- </method>
- <field name="PARTITIONER_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Defines a way to partition keys based on certain key fields (also see
- {@link KeyFieldBasedComparator}.
- The key specification supported is of the form -k pos1[,pos2], where,
- pos is of the form f[.c][opts], where f is the number
- of the key field to use, and c is the number of the first character from
- the beginning of the field. Fields and character posns are numbered
- starting with 1; a character position of zero in pos2 indicates the
- field's last character. If '.c' is omitted from pos1, it defaults to 1
- (the beginning of the field); if omitted from pos2, it defaults to 0
- (the end of the field).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.KeyFieldBasedPartitioner -->
- <!-- start class org.apache.hadoop.mapreduce.lib.partition.TotalOrderPartitioner -->
- <class name="TotalOrderPartitioner" extends="org.apache.hadoop.mapreduce.Partitioner"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="TotalOrderPartitioner"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Read in the partition file and build indexing data structures.
- If the keytype is {@link org.apache.hadoop.io.BinaryComparable} and
- <tt>total.order.partitioner.natural.order</tt> is not false, a trie
- of the first <tt>total.order.partitioner.max.trie.depth</tt>(2) + 1 bytes
- will be built. Otherwise, keys will be located using a binary search of
- the partition keyset using the {@link org.apache.hadoop.io.RawComparator}
- defined for this job. The input file must be sorted with the same
- comparator and contain {@link Job#getNumReduceTasks()} - 1 keys.]]>
- </doc>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPartition" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="java.lang.Object"/>
- <param name="numPartitions" type="int"/>
- </method>
- <method name="setPartitionFile"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="p" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the path to the SequenceFile storing the sorted partition keyset.
- It must be the case that for <tt>R</tt> reduces, there are <tt>R-1</tt>
- keys in the SequenceFile.]]>
- </doc>
- </method>
- <method name="getPartitionFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Get the path to the SequenceFile storing the sorted partition keyset.
- @see #setPartitionFile(Configuration, Path)]]>
- </doc>
- </method>
- <field name="DEFAULT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PARTITIONER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_TRIE_DEPTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NATURAL_ORDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Partitioner effecting a total order by reading split points from
- an externally generated source.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.partition.TotalOrderPartitioner -->
- </package>
- <package name="org.apache.hadoop.mapreduce.lib.reduce">
- <!-- start class org.apache.hadoop.mapreduce.lib.reduce.IntSumReducer -->
- <class name="IntSumReducer" extends="org.apache.hadoop.mapreduce.Reducer"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IntSumReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.lang.Iterable"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.reduce.IntSumReducer -->
- <!-- start class org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer -->
- <class name="LongSumReducer" extends="org.apache.hadoop.mapreduce.Reducer"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LongSumReducer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="reduce"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.Object"/>
- <param name="values" type="java.lang.Iterable"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer -->
- </package>
- <package name="org.apache.hadoop.mapreduce.security">
- <!-- start class org.apache.hadoop.mapreduce.security.SecureShuffleUtils -->
- <class name="SecureShuffleUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SecureShuffleUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="generateHash" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="msg" type="byte[]"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <doc>
- <![CDATA[Base64 encoded hash of msg
- @param msg]]>
- </doc>
- </method>
- <method name="hashFromString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="enc_str" type="java.lang.String"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Aux util to calculate hash of a String
- @param enc_str
- @param key
- @return Base64 encodedHash
- @throws IOException]]>
- </doc>
- </method>
- <method name="verifyReply"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="base64Hash" type="java.lang.String"/>
- <param name="msg" type="java.lang.String"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[verify that base64Hash is same as HMacHash(msg)
- @param base64Hash (Base64 encoded hash)
- @param msg
- @throws IOException if not the same]]>
- </doc>
- </method>
- <method name="buildMsgFrom" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.net.URL"/>
- <doc>
- <![CDATA[Shuffle specific utils - build string for encoding from URL
- @param url
- @return string for encoding]]>
- </doc>
- </method>
- <method name="buildMsgFrom" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="javax.servlet.http.HttpServletRequest"/>
- <doc>
- <![CDATA[Shuffle specific utils - build string for encoding from URL
- @param request
- @return string for encoding]]>
- </doc>
- </method>
- <method name="toHex" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ba" type="byte[]"/>
- <doc>
- <![CDATA[byte array to Hex String
- @param ba
- @return string with HEX value of the key]]>
- </doc>
- </method>
- <field name="HTTP_HEADER_URL_HASH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HTTP_HEADER_REPLY_URL_HASH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[utilities for generating kyes, hashes and verifying them for shuffle]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.SecureShuffleUtils -->
- <!-- start class org.apache.hadoop.mapreduce.security.TokenCache -->
- <class name="TokenCache" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TokenCache"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSecretKey" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <param name="alias" type="org.apache.hadoop.io.Text"/>
- <doc>
- <![CDATA[auxiliary method to get user's secret keys..
- @param alias
- @return secret key from the storage]]>
- </doc>
- </method>
- <method name="obtainTokensForNamenodes"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <param name="ps" type="org.apache.hadoop.fs.Path[]"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Convenience method to obtain delegation tokens from namenodes
- corresponding to the paths passed.
- @param ps array of paths
- @param conf configuration
- @throws IOException]]>
- </doc>
- </method>
- <method name="cleanUpTokenReferral"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Remove jobtoken referrals which don't make sense in the context
- of the task execution.
- @param conf configuration object.]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <param name="namenode" type="java.lang.String"/>
- <doc>
- <![CDATA[@param namenode
- @return delegation token]]>
- </doc>
- </method>
- <method name="loadTokens" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobTokenFile" type="java.lang.String"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[load job token from a file
- @param conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="setJobToken"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="t" type="org.apache.hadoop.security.token.Token"/>
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[store job token
- @param t]]>
- </doc>
- </method>
- <method name="getJobToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[@return job token]]>
- </doc>
- </method>
- <field name="JOB_TOKEN_HDFS_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[file name used on HDFS for generated job token]]>
- </doc>
- </field>
- <field name="JOB_TOKENS_FILENAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[conf setting for job tokens cache file name]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This class provides user facing APIs for transferring secrets from
- the job client to the tasks.
- The secrets can be stored just before submission of jobs and read during
- the task execution.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.TokenCache -->
- </package>
- <package name="org.apache.hadoop.mapreduce.security.token">
- <!-- start class org.apache.hadoop.mapreduce.security.token.DelegationTokenRenewal -->
- <class name="DelegationTokenRenewal" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenRenewal"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="registerDelegationTokensForRenewal"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="ts" type="org.apache.hadoop.security.Credentials"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="true"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[removing all tokens renewals]]>
- </doc>
- </method>
- <method name="removeDelegationTokenRenewalForJob"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <doc>
- <![CDATA[removing DT for completed jobs
- @param jobId]]>
- </doc>
- </method>
- <field name="SCHEME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.DelegationTokenRenewal -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier -->
- <class name="JobTokenIdentifier" extends="org.apache.hadoop.security.token.TokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor]]>
- </doc>
- </constructor>
- <constructor name="JobTokenIdentifier" type="org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a job token identifier from a jobid
- @param jobid the jobid to use]]>
- </doc>
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getUser" return="org.apache.hadoop.security.UserGroupInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getJobId" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the jobid
- @return the jobid]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <field name="KIND_NAME" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The token identifier for job token]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier.Renewer -->
- <class name="JobTokenIdentifier.Renewer" extends="org.apache.hadoop.security.token.Token.TrivialRenewer"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTokenIdentifier.Renewer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier.Renewer -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.JobTokenSecretManager -->
- <class name="JobTokenSecretManager" extends="org.apache.hadoop.security.token.SecretManager"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTokenSecretManager"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default constructor]]>
- </doc>
- </constructor>
- <method name="createSecretKey" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="byte[]"/>
- <doc>
- <![CDATA[Convert the byte[] to a secret key
- @param key the byte[] to create the secret key from
- @return the secret key]]>
- </doc>
- </method>
- <method name="computeHash" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="msg" type="byte[]"/>
- <param name="key" type="javax.crypto.SecretKey"/>
- <doc>
- <![CDATA[Compute the HMAC hash of the message using the key
- @param msg the message to hash
- @param key the key to use
- @return the computed hash]]>
- </doc>
- </method>
- <method name="createPassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier"/>
- <doc>
- <![CDATA[Create a new password/secret for the given job token identifier.
- @param identifier the job token identifier
- @return token password/secret]]>
- </doc>
- </method>
- <method name="addTokenForJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="java.lang.String"/>
- <param name="token" type="org.apache.hadoop.security.token.Token"/>
- <doc>
- <![CDATA[Add the job token of a job to cache
- @param jobId the job that owns the token
- @param token the job token]]>
- </doc>
- </method>
- <method name="removeTokenForJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="java.lang.String"/>
- <doc>
- <![CDATA[Remove the cached job token of a job from cache
- @param jobId the job whose token is to be removed]]>
- </doc>
- </method>
- <method name="retrieveTokenSecret" return="javax.crypto.SecretKey"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="java.lang.String"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <doc>
- <![CDATA[Look up the token password/secret for the given jobId.
- @param jobId the jobId to look up
- @return token password/secret as SecretKey
- @throws InvalidToken]]>
- </doc>
- </method>
- <method name="retrievePassword" return="byte[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="identifier" type="org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier"/>
- <exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
- <doc>
- <![CDATA[Look up the token password/secret for the given job token identifier.
- @param identifier the job token identifier to look up
- @return token password/secret as byte[]
- @throws InvalidToken]]>
- </doc>
- </method>
- <method name="createIdentifier" return="org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty job token identifier
- @return a newly created empty job token identifier]]>
- </doc>
- </method>
- <doc>
- <![CDATA[SecretManager for job token. It can be used to cache generated job tokens.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.JobTokenSecretManager -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.JobTokenSelector -->
- <class name="JobTokenSelector" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.security.token.TokenSelector"/>
- <constructor name="JobTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="selectToken" return="org.apache.hadoop.security.token.Token"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="service" type="org.apache.hadoop.io.Text"/>
- <param name="tokens" type="java.util.Collection"/>
- </method>
- <doc>
- <![CDATA[Look through tokens to find the first job token that matches the service
- and return it.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.JobTokenSelector -->
- </package>
- <package name="org.apache.hadoop.mapreduce.security.token.delegation">
- <!-- start class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenIdentifier -->
- <class name="DelegationTokenIdentifier" extends="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenIdentifier"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an empty delegation token identifier for reading into.]]>
- </doc>
- </constructor>
- <constructor name="DelegationTokenIdentifier" type="org.apache.hadoop.io.Text, org.apache.hadoop.io.Text, org.apache.hadoop.io.Text"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new delegation token identifier
- @param owner the effective username of the token owner
- @param renewer the username of the renewer
- @param realUser the real username of the token owner]]>
- </doc>
- </constructor>
- <method name="getKind" return="org.apache.hadoop.io.Text"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="MAPREDUCE_DELEGATION_KIND" type="org.apache.hadoop.io.Text"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A delegation token identifier that is specific to MapReduce.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenIdentifier -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenSecretManager -->
- <class name="DelegationTokenSecretManager" extends="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenSecretManager" type="long, long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a secret manager
- @param delegationKeyUpdateInterval the number of seconds for rolling new
- secret keys.
- @param delegationTokenMaxLifetime the maximum lifetime of the delegation
- tokens
- @param delegationTokenRenewInterval how often the tokens must be renewed
- @param delegationTokenRemoverScanInterval how often the tokens are scanned
- for expired tokens]]>
- </doc>
- </constructor>
- <method name="createIdentifier" return="org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenIdentifier"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[A MapReduce specific delegation token secret manager.
- The secret manager is responsible for generating and accepting the password
- for each token.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenSecretManager -->
- <!-- start class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenSelector -->
- <class name="DelegationTokenSelector" extends="org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSelector"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DelegationTokenSelector"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[A delegation token that is specialized for MapReduce]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.security.token.delegation.DelegationTokenSelector -->
- </package>
- <package name="org.apache.hadoop.mapreduce.server.jobtracker">
- <!-- start class org.apache.hadoop.mapreduce.server.jobtracker.TaskTracker -->
- <class name="TaskTracker" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskTracker" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a new {@link TaskTracker}.
- @param trackerName Unique identifier for the <code>TaskTracker</code>]]>
- </doc>
- </constructor>
- <method name="getTrackerName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the unique identifier for the {@link TaskTracker}
- @return the unique identifier for the <code>TaskTracker</code>]]>
- </doc>
- </method>
- <method name="getStatus" return="org.apache.hadoop.mapred.TaskTrackerStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the current {@link TaskTrackerStatus} of the <code>TaskTracker</code>.
- @return the current <code>TaskTrackerStatus</code> of the
- <code>TaskTracker</code>]]>
- </doc>
- </method>
- <method name="setStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="status" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
- <doc>
- <![CDATA[Set the current {@link TaskTrackerStatus} of the <code>TaskTracker</code>.
- @param status the current <code>TaskTrackerStatus</code> of the
- <code>TaskTracker</code>]]>
- </doc>
- </method>
- <method name="getAvailableSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <doc>
- <![CDATA[Get the number of currently available slots on this tasktracker for the
- given type of the task.
- @param taskType the {@link TaskType} to check for number of available slots
- @return the number of currently available slots for the given
- <code>taskType</code>]]>
- </doc>
- </method>
- <method name="getJobForFallowSlot" return="org.apache.hadoop.mapred.JobInProgress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <doc>
- <![CDATA[Get the {@link JobInProgress} for which the fallow slot(s) are held.
- @param taskType {@link TaskType} of the task
- @return the task for which the fallow slot(s) are held,
- <code>null</code> if there are no fallow slots]]>
- </doc>
- </method>
- <method name="reserveSlots"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="job" type="org.apache.hadoop.mapred.JobInProgress"/>
- <param name="numSlots" type="int"/>
- <doc>
- <![CDATA[Reserve specified number of slots for a given <code>job</code>.
- @param taskType {@link TaskType} of the task
- @param job the job for which slots on this <code>TaskTracker</code>
- are to be reserved
- @param numSlots number of slots to be reserved]]>
- </doc>
- </method>
- <method name="unreserveSlots"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="job" type="org.apache.hadoop.mapred.JobInProgress"/>
- <doc>
- <![CDATA[Free map slots on this <code>TaskTracker</code> which were reserved for
- <code>taskType</code>.
- @param taskType {@link TaskType} of the task
- @param job job whose slots are being un-reserved]]>
- </doc>
- </method>
- <method name="cancelAllReservations"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Cleanup when the {@link TaskTracker} is declared as 'lost/blacklisted'
- by the JobTracker.
-
- The method assumes that the lock on the {@link JobTracker} is obtained
- by the caller.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The representation of a single <code>TaskTracker</code> as seen by
- the {@link JobTracker}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.jobtracker.TaskTracker -->
- </package>
- <package name="org.apache.hadoop.mapreduce.server.tasktracker">
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo -->
- <class name="JVMInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JVMInfo" type="java.io.File, java.util.List"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLogLocation" return="java.io.File"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAllAttempts" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.Localizer -->
- <class name="Localizer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Localizer" type="org.apache.hadoop.fs.FileSystem, java.lang.String[]"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a Localizer instance
-
- @param fileSys
- @param lDirs]]>
- </doc>
- </constructor>
- <method name="initializeUserDirs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize the local directories for a particular user on this TT. This
- involves creation and setting permissions of the following directories
- <ul>
- <li>$mapred.local.dir/taskTracker/$user</li>
- <li>$mapred.local.dir/taskTracker/$user/jobcache</li>
- <li>$mapred.local.dir/taskTracker/$user/distcache</li>
- </ul>
-
- @param user
- @throws IOException]]>
- </doc>
- </method>
- <method name="initializeAttemptDirs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- <param name="jobId" type="java.lang.String"/>
- <param name="attemptId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create taskDirs on all the disks. Otherwise, in some cases, like when
- LinuxTaskController is in use, child might wish to balance load across
- disks but cannot itself create attempt directory because of the fact that
- job directory is writable only by the TT.
-
- @param user
- @param jobId
- @param attemptId
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[NOTE: This class is internal only and not intended for users!!]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.Localizer -->
- </package>
- <package name="org.apache.hadoop.mapreduce.server.tasktracker.userlogs">
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.DeleteJobEvent -->
- <class name="DeleteJobEvent" extends="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DeleteJobEvent" type="org.apache.hadoop.mapreduce.JobID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the event to delete job log directory.
-
- @param jobid
- The {@link JobID} whose logs should be deleted.]]>
- </doc>
- </constructor>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the jobid.
-
- @return object of {@link JobID}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is an {@link UserLogEvent} sent when job logs should be deleted.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.DeleteJobEvent -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JobCompletedEvent -->
- <class name="JobCompletedEvent" extends="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobCompletedEvent" type="org.apache.hadoop.mapreduce.JobID, long, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the event for job completion.
-
- @param jobid
- The completed {@link JobID} .
- @param jobCompletionTime
- The job completion time.
- @param retainHours
- The number of hours for which the job logs should be retained]]>
- </doc>
- </constructor>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job id.
-
- @return object of {@link JobID}]]>
- </doc>
- </method>
- <method name="getJobCompletionTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job completion time-stamp in milli-seconds.
-
- @return job completion time.]]>
- </doc>
- </method>
- <method name="getRetainHours" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of hours for which job logs should be retained.
-
- @return retainHours]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is an {@link UserLogEvent} sent when the job completes]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JobCompletedEvent -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JobStartedEvent -->
- <class name="JobStartedEvent" extends="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobStartedEvent" type="org.apache.hadoop.mapreduce.JobID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the event to inform the job has started.
-
- @param jobid
- The {@link JobID} which started]]>
- </doc>
- </constructor>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job id.
-
- @return object of {@link JobID}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is an {@link UserLogEvent} sent when the job starts.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JobStartedEvent -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JvmFinishedEvent -->
- <class name="JvmFinishedEvent" extends="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JvmFinishedEvent" type="org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create the event to inform that the jvm has finished.
-
- @param jvmInfo
- The finished {@link JVMInfo}]]>
- </doc>
- </constructor>
- <method name="getJvmInfo" return="org.apache.hadoop.mapreduce.server.tasktracker.JVMInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the jvm info.
-
- @return object of {@link JVMInfo}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is an {@link UserLogEvent} sent when the jvm finishes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.JvmFinishedEvent -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent -->
- <class name="UserLogEvent" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UserLogEvent" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getEventType" return="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the {@link EventType}.
- @return the {@link EventType}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A directive from the various components of {@link TaskTracker} to the
- {@link UserLogManager} to inform about an event.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType -->
- <class name="UserLogEvent.EventType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="JVM_FINISHED" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_STARTED" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_COMPLETED" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELETE_JOB" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent.EventType -->
- <!-- start class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogManager -->
- <class name="UserLogManager" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UserLogManager" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.TaskController"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the user log manager to manage user logs on {@link TaskTracker}.
-
- It should be explicitly started using {@link #start()} to start functioning
-
- @param conf The {@link Configuration}
- @param taskController The task controller to delete the log files
-
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="UserLogManager" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create the user log manager to manage user logs on {@link TaskTracker}.
- This constructor is there mainly for unit tests.
-
- @param conf The {@link Configuration}
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="getTaskController" return="org.apache.hadoop.mapred.TaskController"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the taskController for deleting logs.
- @return the TaskController]]>
- </doc>
- </method>
- <method name="start"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Starts managing the logs]]>
- </doc>
- </method>
- <method name="monitor"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="processEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="clearOldUserLogs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Called during TaskTracker restart/re-init.
-
- @param conf
- TT's conf
- @throws IOException]]>
- </doc>
- </method>
- <method name="addLogEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogEvent"/>
- <doc>
- <![CDATA[Add the {@link UserLogEvent} for processing.
-
- @param event]]>
- </doc>
- </method>
- <method name="getUserLogCleaner" return="org.apache.hadoop.mapred.UserLogCleaner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link UserLogCleaner}.
-
- This method is called only from unit tests.
-
- @return {@link UserLogCleaner}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This manages user logs on the {@link TaskTracker}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.server.tasktracker.userlogs.UserLogManager -->
- </package>
- <package name="org.apache.hadoop.mapreduce.split">
- <!-- start class org.apache.hadoop.mapreduce.split.JobSplit -->
- <class name="JobSplit" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobSplit"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="EMPTY_TASK_SPLIT" type="org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitMetaInfo"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class groups the fundamental classes associated with
- reading/writing splits. The split information is divided into
- two parts based on the consumer of the information. The two
- parts are the split meta information, and the raw split
- information. The first part is consumed by the JobTracker to
- create the tasks' locality data structures. The second part is
- used by the maps at runtime to know what to do!
- These pieces of information are written to two separate files.
- The metainformation file is slurped by the JobTracker during
- job initialization. A map task gets the meta information during
- the launch and it reads the raw split bytes directly from the
- file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.JobSplit -->
- <!-- start class org.apache.hadoop.mapreduce.split.JobSplit.SplitMetaInfo -->
- <class name="JobSplit.SplitMetaInfo" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <constructor name="JobSplit.SplitMetaInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobSplit.SplitMetaInfo" type="java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobSplit.SplitMetaInfo" type="org.apache.hadoop.mapreduce.InputSplit, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputDataLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInputDataLocations"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="locations" type="java.lang.String[]"/>
- </method>
- <method name="setInputDataLength"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="length" type="long"/>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This represents the meta information about the task split.
- The main fields are
- - start offset in actual split
- - data length that will be processed in this split
- - hosts on which this split is local]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.JobSplit.SplitMetaInfo -->
- <!-- start class org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitIndex -->
- <class name="JobSplit.TaskSplitIndex" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobSplit.TaskSplitIndex"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobSplit.TaskSplitIndex" type="java.lang.String, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getStartOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSplitLocation" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[This represents the meta information about the task split that the
- task gets]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitIndex -->
- <!-- start class org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitMetaInfo -->
- <class name="JobSplit.TaskSplitMetaInfo" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobSplit.TaskSplitMetaInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobSplit.TaskSplitMetaInfo" type="org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitIndex, java.lang.String[], long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="JobSplit.TaskSplitMetaInfo" type="org.apache.hadoop.mapreduce.InputSplit, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="JobSplit.TaskSplitMetaInfo" type="java.lang.String[], long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplitIndex" return="org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitIndex"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSplitLocation" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputDataLength" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLocations" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartOffset" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This represents the meta information about the task split that the
- JobTracker creates]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitMetaInfo -->
- <!-- start class org.apache.hadoop.mapreduce.split.JobSplitWriter -->
- <class name="JobSplitWriter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobSplitWriter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="createSplitFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="splits" type="java.util.List"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="createSplitFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="splits" type="org.apache.hadoop.mapreduce.InputSplit[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- </method>
- <method name="createSplitFiles"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="splits" type="org.apache.hadoop.mapred.InputSplit[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[The class that is used by the Job clients to write splits (both the meta
- and the raw bytes parts)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.JobSplitWriter -->
- <!-- start class org.apache.hadoop.mapreduce.split.SplitMetaInfoReader -->
- <class name="SplitMetaInfoReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SplitMetaInfoReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="readSplitMetaInfo" return="org.apache.hadoop.mapreduce.split.JobSplit.TaskSplitMetaInfo[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobId" type="org.apache.hadoop.mapreduce.JobID"/>
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="jobSubmitDir" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A (internal) utility that reads the split meta info and creates
- split meta info objects]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.mapreduce.split.SplitMetaInfoReader -->
- </package>
- <package name="org.apache.hadoop.tools">
- <!-- start class org.apache.hadoop.tools.DistCh -->
- <class name="DistCh" extends="org.apache.hadoop.tools.DistTool"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[This is the main driver for recursively changing files properties.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[A Map-reduce program to recursively change files properties
- such as owner, group and permission.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.DistCh -->
- <!-- start class org.apache.hadoop.tools.DistCp -->
- <class name="DistCp" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="DistCp" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="copy"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="srcPath" type="java.lang.String"/>
- <param name="destPath" type="java.lang.String"/>
- <param name="logPath" type="org.apache.hadoop.fs.Path"/>
- <param name="srcAsList" type="boolean"/>
- <param name="ignoreReadFailures" type="boolean"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[This is the main driver for recursively copying directories
- across file systems. It takes at least two cmdline parameters. A source
- URL and a destination URL. It then essentially does an "ls -lR" on the
- source URL, and writes the output in a round-robin manner to all the map
- input files. The mapper actually copies the files allotted to it. The
- reduce is empty.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <method name="getRandomId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="LOG" type="org.apache.commons.logging.Log"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[A Map-reduce program to recursively copy directories between
- different file-systems.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.DistCp -->
- <!-- start class org.apache.hadoop.tools.DistCp.DuplicationException -->
- <class name="DistCp.DuplicationException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="ERROR_CODE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code for this exception]]>
- </doc>
- </field>
- <doc>
- <![CDATA[An exception class for duplicated source files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.DistCp.DuplicationException -->
- <!-- start class org.apache.hadoop.tools.HadoopArchives -->
- <class name="HadoopArchives" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="HadoopArchives" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[the main driver for creating the archives
- it takes at least three command line parameters. The parent path,
- The src and the dest. It does an lsr on the source paths.
- The mapper created archuves and the reducer creates
- the archive index.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[the main functions]]>
- </doc>
- </method>
- <field name="VERSION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[a archive creation utility.
- This class provides methods that can be used
- to create hadoop archives. For understanding of
- Hadoop archives look at {@link HarFileSystem}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.HadoopArchives -->
- <!-- start class org.apache.hadoop.tools.Logalyzer -->
- <class name="Logalyzer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Logalyzer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="doArchive"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logListURI" type="java.lang.String"/>
- <param name="archiveDirectory" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[doArchive: Workhorse function to archive log-files.
- @param logListURI : The uri which will serve list of log-files to archive.
- @param archiveDirectory : The directory to store archived logfiles.
- @throws IOException]]>
- </doc>
- </method>
- <method name="doAnalyze"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputFilesDirectory" type="java.lang.String"/>
- <param name="outputDirectory" type="java.lang.String"/>
- <param name="grepPattern" type="java.lang.String"/>
- <param name="sortColumns" type="java.lang.String"/>
- <param name="columnSeparator" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[doAnalyze:
- @param inputFilesDirectory : Directory containing the files to be analyzed.
- @param outputDirectory : Directory to store analysis (output).
- @param grepPattern : Pattern to *grep* for.
- @param sortColumns : Sort specification for output.
- @param columnSeparator : Column separator.
- @throws IOException]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <doc>
- <![CDATA[Logalyzer: A utility tool for archiving and analyzing hadoop logs.
- <p>
- This tool supports archiving and anaylzing (sort/grep) of log-files.
- It takes as input
- a) Input uri which will serve uris of the logs to be archived.
- b) Output directory (not mandatory).
- b) Directory on dfs to archive the logs.
- c) The sort/grep patterns for analyzing the files and separator for boundaries.
- Usage:
- Logalyzer -archive -archiveDir <directory to archive logs> -analysis <directory> -logs <log-list uri> -grep <pattern> -sort <col1, col2> -separator <separator>
- <p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.Logalyzer -->
- <!-- start class org.apache.hadoop.tools.Logalyzer.LogComparator -->
- <class name="Logalyzer.LogComparator" extends="org.apache.hadoop.io.Text.Comparator"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.conf.Configurable"/>
- <constructor name="Logalyzer.LogComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getConf" return="org.apache.hadoop.conf.Configuration"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b1" type="byte[]"/>
- <param name="s1" type="int"/>
- <param name="l1" type="int"/>
- <param name="b2" type="byte[]"/>
- <param name="s2" type="int"/>
- <param name="l2" type="int"/>
- </method>
- <doc>
- <![CDATA[A WritableComparator optimized for UTF8 keys of the logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.Logalyzer.LogComparator -->
- <!-- start class org.apache.hadoop.tools.Logalyzer.LogRegexMapper -->
- <class name="Logalyzer.LogRegexMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.mapred.Mapper"/>
- <constructor name="Logalyzer.LogRegexMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="configure"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
- <param name="value" type="org.apache.hadoop.io.Text"/>
- <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
- <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A {@link Mapper} that extracts text matching a regular expression.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.Logalyzer.LogRegexMapper -->
- </package>
- <package name="org.apache.hadoop.tools.distcp2">
- <!-- start class org.apache.hadoop.tools.distcp2.CopyListing -->
- <class name="CopyListing" extends="org.apache.hadoop.conf.Configured"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CopyListing" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.Credentials"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Protected constructor, to initialize configuration.
- @param configuration The input configuration,
- with which the source/target FileSystems may be accessed.
- @param credentials - Credentials object on which the FS delegation tokens are cached.If null
- delegation token caching is skipped]]>
- </doc>
- </constructor>
- <method name="buildListing"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <param name="pathToListFile" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Build listing function creates the input listing that distcp uses to
- perform the copy.
- The build listing is a sequence file that has relative path of a file in the key
- and the file status information of the source file in the value
- For instance if the source path is /tmp/data and the traversed path is
- /tmp/data/dir1/dir2/file1, then the sequence file would contain
- key: /dir1/dir2/file1 and value: FileStatus(/tmp/data/dir1/dir2/file1)
- File would also contain directory entries. Meaning, if /tmp/data/dir1/dir2/file1
- is the only file under /tmp/data, the resulting sequence file would contain the
- following entries
- key: /dir1 and value: FileStatus(/tmp/data/dir1)
- key: /dir1/dir2 and value: FileStatus(/tmp/data/dir1/dir2)
- key: /dir1/dir2/file1 and value: FileStatus(/tmp/data/dir1/dir2/file1)
- Cases requiring special handling:
- If source path is a file (/tmp/file1), contents of the file will be as follows
- TARGET DOES NOT EXIST: Key-"", Value-FileStatus(/tmp/file1)
- TARGET IS FILE : Key-"", Value-FileStatus(/tmp/file1)
- TARGET IS DIR : Key-"/file1", Value-FileStatus(/tmp/file1)
- @param pathToListFile - Output file where the listing would be stored
- @param options - Input options to distcp
- @throws IOException - Exception if any]]>
- </doc>
- </method>
- <method name="validatePaths"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="CopyListing.InvalidInputException" type="org.apache.hadoop.tools.distcp2.CopyListing.InvalidInputException"/>
- <doc>
- <![CDATA[Validate input and output paths
- @param options - Input options
- @throws InvalidInputException: If inputs are invalid
- @throws IOException: any Exception with FS]]>
- </doc>
- </method>
- <method name="doBuildListing"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="pathToListFile" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[The interface to be implemented by sub-classes, to create the source/target file listing.
- @param pathToListFile Path on HDFS where the listing file is written.
- @param options Input Options for DistCp (indicating source/target paths.)
- @throws IOException: Thrown on failure to create the listing file.]]>
- </doc>
- </method>
- <method name="getBytesToCopy" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the total bytes that distCp should copy for the source paths
- This doesn't consider whether file is same should be skipped during copy
- @return total bytes to copy]]>
- </doc>
- </method>
- <method name="getNumberOfPaths" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return the total number of paths to distcp, includes directories as well
- This doesn't consider whether file/dir is already present and should be skipped during copy
- @return Total number of paths to distcp]]>
- </doc>
- </method>
- <method name="setCredentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <doc>
- <![CDATA[set Credentials store, on which FS delegatin token will be cached
- @param credentials - Credentials object]]>
- </doc>
- </method>
- <method name="getCredentials" return="org.apache.hadoop.security.Credentials"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[get credentials to update the delegation tokens for accessed FS objects
- @return Credentials object]]>
- </doc>
- </method>
- <method name="getCopyListing" return="org.apache.hadoop.tools.distcp2.CopyListing"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <param name="credentials" type="org.apache.hadoop.security.Credentials"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Public Factory method with which the appropriate CopyListing implementation may be retrieved.
- @param configuration The input configuration.
- @param credentials Credentials object on which the FS delegation tokens are cached
- @param options The input Options, to help choose the appropriate CopyListing Implementation.
- @return An instance of the appropriate CopyListing implementation.
- @throws java.io.IOException - Exception if any]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The CopyListing abstraction is responsible for how the list of
- sources and targets is constructed, for DistCp's copy function.
- The copy-listing should be a SequenceFile<Text, FileStatus>,
- located at the path specified to buildListing(),
- each entry being a pair of (Source relative path, source file status),
- all the paths being fully qualified.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.CopyListing -->
- <!-- start class org.apache.hadoop.tools.distcp2.DistCp -->
- <class name="DistCp" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="DistCp" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.tools.distcp2.DistCpOptions"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Public Constructor. Creates DistCp object with specified input-parameters.
- (E.g. source-paths, target-location, etc.)
- @param inputOptions Options (indicating source-paths, target-location.)
- @param configuration The Hadoop configuration against which the Copy-mapper must run.
- @throws Exception, on failure.]]>
- </doc>
- </constructor>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Implementation of Tool::run(). Orchestrates the copy of source file(s)
- to target location, by:
- 1. Creating a list of files to be copied to target.
- 2. Launching a Map-only job to copy the files. (Delegates to execute().)
- @param argv List of arguments passed to DistCp, from the ToolRunner.
- @return On success, it returns 0. Else, -1.]]>
- </doc>
- </method>
- <method name="execute" return="org.apache.hadoop.mapreduce.Job"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Implements the core-execution. Creates the file-list for copy,
- and launches the Hadoop-job, to do the copy.
- @return Job handle
- @throws Exception, on failure.]]>
- </doc>
- </method>
- <method name="createInputFileListing" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create input listing by invoking an appropriate copy listing
- implementation. Also add delegation tokens for each path
- to job's credential store
- @param job - Handle to job
- @return Returns the path where the copy listing is created
- @throws IOException - If any]]>
- </doc>
- </method>
- <method name="getFileListingPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get default name of the copy listing file. Use the meta folder
- to create the copy listing file
- @return - Path where the copy listing file has to be saved
- @throws IOException - Exception if any]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="argv" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Main function of the DistCp program. Parses the input arguments (via OptionsParser),
- and invokes the DistCp::run() method, via the ToolRunner.
- @param argv Command-line arguments sent to DistCp.]]>
- </doc>
- </method>
- <field name="rand" type="java.util.Random"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[DistCp is the main driver-class for DistCpV2.
- For command-line use, DistCp::main() orchestrates the parsing of command-line
- parameters and the launch of the DistCp job.
- For programmatic use, a DistCp object can be constructed by specifying
- options (in a DistCpOptions object), and DistCp::execute() may be used to
- launch the copy-job. DistCp may alternatively be sub-classed to fine-tune
- behaviour.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.DistCp -->
- <!-- start class org.apache.hadoop.tools.distcp2.DistCpConstants -->
- <class name="DistCpConstants" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DistCpConstants"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="DEFAULT_MAPS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_BANDWIDTH_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNIFORMSIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_ATOMIC_COPY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constants mapping to command line switches/input options]]>
- </doc>
- </field>
- <field name="CONF_LABEL_WORK_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_LOG_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_IGNORE_FAILURES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_PRESERVE_STATUS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SYNC_FOLDERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_DELETE_MISSING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SSL_CONF" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_MAX_MAPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SOURCE_LISTING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_COPY_STRATEGY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SKIP_CRC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_OVERWRITE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_BANDWIDTH_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_TOTAL_BYTES_TO_BE_COPIED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_TOTAL_NUMBER_OF_RECORDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SSL_KEYSTORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_LISTING_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_TARGET_WORK_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_TARGET_FINAL_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_DISTCP_JOB_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[DistCp job id for consumers of the Disctp]]>
- </doc>
- </field>
- <field name="CONF_LABEL_META_FOLDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_COPY_LISTING_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONF_LABEL_SSL_TRUST_STORE_LOCATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Conf label for SSL Trust-store location.]]>
- </doc>
- </field>
- <field name="CONF_LABEL_SSL_KEY_STORE_LOCATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Conf label for SSL Key-store location.]]>
- </doc>
- </field>
- <field name="SUCCESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constants for DistCp return code to shell / consumer of ToolRunner's run]]>
- </doc>
- </field>
- <field name="INVALID_ARGUMENT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DUPLICATE_INPUT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="UNKNOWN_ERROR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Utility class to hold commonly used constants.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.DistCpConstants -->
- <!-- start class org.apache.hadoop.tools.distcp2.DistCpOptions -->
- <class name="DistCpOptions" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DistCpOptions" type="java.util.List, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, to initialize source/target paths.
- @param sourcePaths List of source-paths (including wildcards)
- to be copied to target.
- @param targetPath Destination path for the dist-copy.]]>
- </doc>
- </constructor>
- <constructor name="DistCpOptions" type="org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, to initialize source/target paths.
- @param sourceFileListing File containing list of source paths
- @param targetPath Destination path for the dist-copy.]]>
- </doc>
- </constructor>
- <constructor name="DistCpOptions" type="org.apache.hadoop.tools.distcp2.DistCpOptions"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy constructor.
- @param that DistCpOptions being copied from.]]>
- </doc>
- </constructor>
- <method name="shouldAtomicCommit" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should the data be committed atomically?
- @return true if data should be committed automically. false otherwise]]>
- </doc>
- </method>
- <method name="setAtomicCommit"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="atomicCommit" type="boolean"/>
- <doc>
- <![CDATA[Set if data need to be committed automatically
- @param atomicCommit - boolean switch]]>
- </doc>
- </method>
- <method name="shouldSyncFolder" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should the data be sync'ed between source and target paths?
- @return true if data should be sync'ed up. false otherwise]]>
- </doc>
- </method>
- <method name="setSyncFolder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="syncFolder" type="boolean"/>
- <doc>
- <![CDATA[Set if source and target folder contents be sync'ed up
- @param syncFolder - boolean switch]]>
- </doc>
- </method>
- <method name="shouldDeleteMissing" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should target files missing in source should be deleted?
- @return true if zoombie target files to be removed. false otherwise]]>
- </doc>
- </method>
- <method name="setDeleteMissing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="deleteMissing" type="boolean"/>
- <doc>
- <![CDATA[Set if files only present in target should be deleted
- @param deleteMissing - boolean switch]]>
- </doc>
- </method>
- <method name="shouldIgnoreFailures" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should failures be logged and ignored during copy?
- @return true if failures are to be logged and ignored. false otherwise]]>
- </doc>
- </method>
- <method name="setIgnoreFailures"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ignoreFailures" type="boolean"/>
- <doc>
- <![CDATA[Set if failures during copy be ignored
- @param ignoreFailures - boolean switch]]>
- </doc>
- </method>
- <method name="shouldBlock" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should DistCp be running in blocking mode
- @return true if should run in blocking, false otherwise]]>
- </doc>
- </method>
- <method name="setBlocking"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="blocking" type="boolean"/>
- <doc>
- <![CDATA[Set if Disctp should run blocking or non-blocking
- @param blocking - boolean switch]]>
- </doc>
- </method>
- <method name="shouldOverwrite" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should files be overwritten always?
- @return true if files in target that may exist before distcp, should always
- be overwritten. false otherwise]]>
- </doc>
- </method>
- <method name="setOverwrite"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="overwrite" type="boolean"/>
- <doc>
- <![CDATA[Set if files should always be overwritten on target
- @param overwrite - boolean switch]]>
- </doc>
- </method>
- <method name="shouldSkipCRC" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should CRC/checksum check be skipped while checking files are identical
- @return true if checksum check should be skipped while checking files are
- identical. false otherwise]]>
- </doc>
- </method>
- <method name="setSkipCRC"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="skipCRC" type="boolean"/>
- <doc>
- <![CDATA[Set if checksum comparison should be skipped while determining if
- source and destination files are identical
- @param skipCRC - boolean switch]]>
- </doc>
- </method>
- <method name="getMaxMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the max number of maps to use for this copy
- @return Max number of maps]]>
- </doc>
- </method>
- <method name="setMaxMaps"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxMaps" type="int"/>
- <doc>
- <![CDATA[Set the max number of maps to use for copy
- @param maxMaps - Number of maps]]>
- </doc>
- </method>
- <method name="getMapBandwidth" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the map bandwidth in MB
- @return Bandwidth in MB]]>
- </doc>
- </method>
- <method name="setMapBandwidth"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mapBandwidth" type="int"/>
- <doc>
- <![CDATA[Set per map bandwidth
- @param mapBandwidth - per map bandwidth]]>
- </doc>
- </method>
- <method name="getSslConfigurationFile" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get path where the ssl configuration file is present to use for hftps://
- @return Path on local file system]]>
- </doc>
- </method>
- <method name="setSslConfigurationFile"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sslConfigurationFile" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the SSL configuration file path to use with hftps:// (local path)
- @param sslConfigurationFile - Local ssl config file path]]>
- </doc>
- </method>
- <method name="preserveAttributes" return="java.util.Iterator"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns an iterator with the list of file attributes to preserve
- @return iterator of file attributes to preserve]]>
- </doc>
- </method>
- <method name="shouldPreserve" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attribute" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"/>
- <doc>
- <![CDATA[Checks if the input attibute should be preserved or not
- @param attribute - Attribute to check
- @return True if attribute should be preserved, false otherwise]]>
- </doc>
- </method>
- <method name="preserve"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fileAttribute" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"/>
- <doc>
- <![CDATA[Add file attributes that need to be preserved. This method may be
- called multiple times to add attributes.
- @param fileAttribute - Attribute to add, one at a time]]>
- </doc>
- </method>
- <method name="getAtomicWorkPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get work path for atomic commit. If null, the work
- path would be parentOf(targetPath) + "/._WIP_" + nameOf(targetPath)
- @return Atomic work path on the target cluster. Null if not set]]>
- </doc>
- </method>
- <method name="setAtomicWorkPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="atomicWorkPath" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the work path for atomic commit
- @param atomicWorkPath - Path on the target cluster]]>
- </doc>
- </method>
- <method name="getLogPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get output directory for writing distcp logs. Otherwise logs
- are temporarily written to JobStagingDir/_logs and deleted
- upon job completion
- @return Log output path on the cluster where distcp job is run]]>
- </doc>
- </method>
- <method name="setLogPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logPath" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the log path where distcp output logs are stored
- Uses JobStagingDir/_logs by default
- @param logPath - Path where logs will be saved]]>
- </doc>
- </method>
- <method name="getCopyStrategy" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the copy strategy to use. Uses appropriate input format
- @return copy strategy to use]]>
- </doc>
- </method>
- <method name="setCopyStrategy"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="copyStrategy" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the copy strategy to use. Should map to a strategy implementation
- in distp-default.xml
- @param copyStrategy - copy Strategy to use]]>
- </doc>
- </method>
- <method name="getSourceFileListing" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[File path (hdfs:// or file://) that contains the list of actual
- files to copy
- @return - Source listing file path]]>
- </doc>
- </method>
- <method name="getSourcePaths" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter for sourcePaths.
- @return List of source-paths.]]>
- </doc>
- </method>
- <method name="setSourcePaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sourcePaths" type="java.util.List"/>
- <doc>
- <![CDATA[Setter for sourcePaths.
- @param sourcePaths The new list of source-paths.]]>
- </doc>
- </method>
- <method name="getTargetPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter for the targetPath.
- @return The target-path.]]>
- </doc>
- </method>
- <method name="validate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="option" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"/>
- <param name="value" type="boolean"/>
- </method>
- <method name="appendToConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Add options to configuration. These will be used in the Mapper/committer
- @param conf - Configruation object to which the options need to be added]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Utility to easily string-ify Options, for logging.
- @return String representation of the Options.]]>
- </doc>
- </method>
- <method name="clone" return="org.apache.hadoop.tools.distcp2.DistCpOptions"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <exception name="CloneNotSupportedException" type="java.lang.CloneNotSupportedException"/>
- </method>
- <doc>
- <![CDATA[The Options class encapsulates all DistCp options.
- These may be set from command-line (via the OptionsParser)
- or may be set manually.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.DistCpOptions -->
- <!-- start class org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute -->
- <class name="DistCpOptions.FileAttribute" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getAttribute" return="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="symbol" type="char"/>
- </method>
- <field name="REPLICATION" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BLOCKSIZE" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USER" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="GROUP" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PERMISSION" type="org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.DistCpOptions.FileAttribute -->
- <!-- start class org.apache.hadoop.tools.distcp2.DistCpOptionSwitch -->
- <class name="DistCpOptionSwitch" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getConfigLabel" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get Configuration label for the option
- @return configuration label name]]>
- </doc>
- </method>
- <method name="getOption" return="org.apache.commons.cli.Option"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get CLI Option corresponding to the distcp option
- @return option]]>
- </doc>
- </method>
- <method name="getSwitch" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get Switch symbol
- @return switch symbol char]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addToConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="option" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"/>
- <param name="value" type="java.lang.String"/>
- <doc>
- <![CDATA[Helper function to add an option to hadoop configuration object
- @param conf - Configuration object to include the option
- @param option - Option to add
- @param value - Value]]>
- </doc>
- </method>
- <method name="addToConf"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="option" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"/>
- <doc>
- <![CDATA[Helper function to set an option to hadoop configuration object
- @param conf - Configuration object to include the option
- @param option - Option to add]]>
- </doc>
- </method>
- <field name="IGNORE_FAILURES" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Ignores any failures during copy, and continues with rest.
- Logs failures in a file]]>
- </doc>
- </field>
- <field name="PRESERVE_STATUS" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Preserves status of file/path in the target.
- Default behavior with -p, is to preserve replication,
- block size, user, group and permission on the target file
- If any of the optional switches are present among rbugp, then
- only the corresponding file attribute is preserved]]>
- </doc>
- </field>
- <field name="SYNC_FOLDERS" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Update target location by copying only files that are missing
- in the target. This can be used to periodically sync two folders
- across source and target. Typically used with DELETE_MISSING
- Incompatible with ATOMIC_COMMIT]]>
- </doc>
- </field>
- <field name="DELETE_MISSING" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Deletes missing files in target that are missing from source
- This allows the target to be in sync with the source contents
- Typically used in conjunction with SYNC_FOLDERS
- Incompatible with ATOMIC_COMMIT]]>
- </doc>
- </field>
- <field name="SSL_CONF" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configuration file to use with hftps:// for securely copying
- files across clusters. Typically the configuration file contains
- truststore/keystore information such as location, password and type]]>
- </doc>
- </field>
- <field name="MAX_MAPS" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max number of maps to use during copy. DistCp will split work
- as equally as possible among these maps]]>
- </doc>
- </field>
- <field name="SOURCE_FILE_LISTING" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Source file listing can be provided to DistCp in a file.
- This allows DistCp to copy random list of files from source
- and copy them to target]]>
- </doc>
- </field>
- <field name="ATOMIC_COMMIT" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy all the source files and commit them atomically to the target
- This is typically useful in cases where there is a process
- polling for availability of a file/dir. This option is incompatible
- with SYNC_FOLDERS & DELETE_MISSING]]>
- </doc>
- </field>
- <field name="WORK_PATH" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Work path to be used only in conjunction in Atomic commit]]>
- </doc>
- </field>
- <field name="LOG_PATH" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Log path where distcp output logs are written to]]>
- </doc>
- </field>
- <field name="COPY_STRATEGY" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Copy strategy is use. This could be dynamic or uniform size etc.
- DistCp would use an appropriate input format based on this.]]>
- </doc>
- </field>
- <field name="SKIP_CRC" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Skip CRC checks between source and target, when determining what
- files need to be copied.]]>
- </doc>
- </field>
- <field name="OVERWRITE" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Overwrite target-files unconditionally.]]>
- </doc>
- </field>
- <field name="BLOCKING" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Should DisctpExecution be blocking]]>
- </doc>
- </field>
- <field name="FILE_LIMIT" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SIZE_LIMIT" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BANDWIDTH" type="org.apache.hadoop.tools.distcp2.DistCpOptionSwitch"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specify bandwidth per map in MB]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Enumeration mapping configuration keys to distcp command line
- options.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.DistCpOptionSwitch -->
- <!-- start class org.apache.hadoop.tools.distcp2.FileBasedCopyListing -->
- <class name="FileBasedCopyListing" extends="org.apache.hadoop.tools.distcp2.CopyListing"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FileBasedCopyListing" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, to initialize base-class.
- @param configuration The input Configuration object.
- @param credentials - Credentials object on which the FS delegation tokens are cached. If null
- delegation token caching is skipped]]>
- </doc>
- </constructor>
- <method name="validatePaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="CopyListing.InvalidInputException" type="org.apache.hadoop.tools.distcp2.CopyListing.InvalidInputException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="doBuildListing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathToListFile" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implementation of CopyListing::buildListing().
- Iterates over all source paths mentioned in the input-file.
- @param pathToListFile Path on HDFS where the listing file is written.
- @param options Input Options for DistCp (indicating source/target paths.)
- @throws IOException]]>
- </doc>
- </method>
- <method name="getBytesToCopy" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getNumberOfPaths" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[FileBasedCopyListing implements the CopyListing interface,
- to create the copy-listing for DistCp,
- by iterating over all source paths mentioned in a specified input-file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.FileBasedCopyListing -->
- <!-- start class org.apache.hadoop.tools.distcp2.GlobbedCopyListing -->
- <class name="GlobbedCopyListing" extends="org.apache.hadoop.tools.distcp2.CopyListing"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GlobbedCopyListing" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.Credentials"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, to initialize the configuration.
- @param configuration The input Configuration object.
- @param credentials Credentials object on which the FS delegation tokens are cached. If null
- delegation token caching is skipped]]>
- </doc>
- </constructor>
- <method name="validatePaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="CopyListing.InvalidInputException" type="org.apache.hadoop.tools.distcp2.CopyListing.InvalidInputException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="doBuildListing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathToListingFile" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implementation of CopyListing::buildListing().
- Creates the copy listing by "globbing" all source-paths.
- @param pathToListingFile The location at which the copy-listing file
- is to be created.
- @param options Input Options for DistCp (indicating source/target paths.)
- @throws IOException]]>
- </doc>
- </method>
- <method name="getBytesToCopy" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getNumberOfPaths" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[GlobbedCopyListing implements the CopyListing interface, to create the copy
- listing-file by "globbing" all specified source paths (wild-cards and all.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.GlobbedCopyListing -->
- <!-- start class org.apache.hadoop.tools.distcp2.OptionsParser -->
- <class name="OptionsParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="OptionsParser"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="parse" return="org.apache.hadoop.tools.distcp2.DistCpOptions"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
- <doc>
- <![CDATA[The parse method parses the command-line options, and creates
- a corresponding Options object.
- @param args Command-line arguments (excluding the options consumed
- by the GenericOptionsParser).
- @return The Options object, corresponding to the specified command-line.
- @throws IllegalArgumentException: Thrown if the parse fails.]]>
- </doc>
- </method>
- <method name="usage"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[The OptionsParser parses out the command-line options passed to DistCp,
- and interprets those specific to DistCp, to create an Options object.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.OptionsParser -->
- <!-- start class org.apache.hadoop.tools.distcp2.SimpleCopyListing -->
- <class name="SimpleCopyListing" extends="org.apache.hadoop.tools.distcp2.CopyListing"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SimpleCopyListing" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.security.Credentials"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Protected constructor, to initialize configuration.
- @param configuration The input configuration, with which the source/target FileSystems may be accessed.
- @param credentials - Credentials object on which the FS delegation tokens are cached. If null
- delegation token caching is skipped]]>
- </doc>
- </constructor>
- <method name="validatePaths"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="CopyListing.InvalidInputException" type="org.apache.hadoop.tools.distcp2.CopyListing.InvalidInputException"/>
- </method>
- <method name="doBuildListing"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pathToListingFile" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="shouldCopy" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <doc>
- <![CDATA[Provide an option to skip copy of a path, Allows for exclusion
- of files such as {@link org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter#SUCCEEDED_FILE_NAME}
- @param path - Path being considered for copy while building the file listing
- @param options - Input options passed during DistCp invocation
- @return - True if the path should be considered for copy, false otherwise]]>
- </doc>
- </method>
- <method name="getBytesToCopy" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <method name="getNumberOfPaths" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[{@inheritDoc}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The SimpleCopyListing is responsible for making the exhaustive list of
- all files/directories under its specified list of input-paths.
- These are written into the specified copy-listing file.
- Note: The SimpleCopyListing doesn't handle wild-cards in the input-paths.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.SimpleCopyListing -->
- </package>
- <package name="org.apache.hadoop.tools.distcp2.mapred">
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.CopyCommitter -->
- <class name="CopyCommitter" extends="org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CopyCommitter" type="org.apache.hadoop.fs.Path, org.apache.hadoop.mapreduce.TaskAttemptContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Create a output committer
- @param outputPath the job's output path
- @param context the task's context
- @throws IOException - Exception if any]]>
- </doc>
- </constructor>
- <method name="commitJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <method name="abortJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <param name="state" type="org.apache.hadoop.mapreduce.JobStatus.State"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The CopyCommitter class is DistCp's OutputCommitter implementation. It is
- responsible for handling the completion/cleanup of the DistCp run.
- Specifically, it does the following:
- 1. Cleanup of the meta-folder (where DistCp maintains its file-list, etc.)
- 2. Preservation of user/group/replication-factor on any directories that
- have been copied. (Files are taken care of in their map-tasks.)
- 3. Atomic-move of data from the temporary work-folder to the final path
- (if atomic-commit was opted for).
- 4. Deletion of files from the target that are missing at source (if opted for).
- 5. Cleanup of any partially copied files, from previous, failed attempts.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.CopyCommitter -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.CopyMapper -->
- <class name="CopyMapper" extends="org.apache.hadoop.mapreduce.Mapper"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CopyMapper"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setup"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of the Mapper::setup() method. This extracts the DistCp-
- options specified in the Job's configuration, to set up the Job.
- @param context Mapper's context.
- @throws IOException On IO failure.
- @throws InterruptedException If the job is interrupted.]]>
- </doc>
- </method>
- <method name="map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relPath" type="org.apache.hadoop.io.Text"/>
- <param name="sourceFileStatus" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of the Mapper<>::map(). Does the copy.
- @param relPath The target path.
- @param sourceFileStatus The source path.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Mapper class that executes the DistCp copy operation.
- Implements the o.a.h.mapreduce.Mapper<> interface.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.CopyMapper -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter -->
- <class name="CopyMapper.Counter" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="COPY" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SKIP" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAIL" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTESCOPIED" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTESEXPECTED" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTESFAILED" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="BYTESSKIPPED" type="org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Hadoop counters for the DistCp CopyMapper.
- (These have been kept identical to the old DistCp,
- for backward compatibility.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.CopyMapper.Counter -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.CopyOutputFormat -->
- <class name="CopyOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.TextOutputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CopyOutputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setWorkingDirectory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="workingDirectory" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Setter for the working directory for DistCp (where files will be copied
- before they are moved to the final commit-directory.)
- @param job The Job on whose configuration the working-directory is to be set.
- @param workingDirectory The path to use as the working directory.]]>
- </doc>
- </method>
- <method name="setCommitDirectory"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <param name="commitDirectory" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Setter for the final directory for DistCp (where files copied will be
- moved, atomically.)
- @param job The Job on whose configuration the working-directory is to be set.
- @param commitDirectory The path to use for final commit.]]>
- </doc>
- </method>
- <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <doc>
- <![CDATA[Getter for the working directory.
- @param job The Job from whose configuration the working-directory is to
- be retrieved.
- @return The working-directory Path.]]>
- </doc>
- </method>
- <method name="getCommitDirectory" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
- <doc>
- <![CDATA[Getter for the final commit-directory.
- @param job The Job from whose configuration the commit-directory is to be
- retrieved.
- @return The commit-directory Path.]]>
- </doc>
- </method>
- <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <method name="checkOutputSpecs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The CopyOutputFormat is the Hadoop OutputFormat used in DistCp.
- It sets up the Job's Configuration (in the Job-Context) with the settings
- for the work-directory, final commit-directory, etc. It also sets the right
- output-committer.
- @param <K>
- @param <V>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.CopyOutputFormat -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.RetriableDirectoryCreateCommand -->
- <class name="RetriableDirectoryCreateCommand" extends="org.apache.hadoop.tools.distcp2.util.RetriableCommand"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetriableDirectoryCreateCommand" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, taking a description of the action.
- @param description Verbose description of the copy operation.]]>
- </doc>
- </constructor>
- <method name="doExecute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="arguments" type="java.lang.Object[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Implementation of RetriableCommand::doExecute().
- This implements the actual mkdirs() functionality.
- @param arguments Argument-list to the command.
- @return Boolean. True, if the directory could be created successfully.
- @throws Exception IOException, on failure to create the directory.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class extends Retriable command to implement the creation of directories
- with retries on failure.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.RetriableDirectoryCreateCommand -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.RetriableFileCopyCommand -->
- <class name="RetriableFileCopyCommand" extends="org.apache.hadoop.tools.distcp2.util.RetriableCommand"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetriableFileCopyCommand" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor, taking a description of the action.
- @param description Verbose description of the copy operation.]]>
- </doc>
- </constructor>
- <constructor name="RetriableFileCopyCommand" type="boolean, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a RetriableFileCopyCommand.
- @param skipCrc Whether to skip the crc check.
- @param description A verbose description of the copy operation.]]>
- </doc>
- </constructor>
- <method name="doExecute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="arguments" type="java.lang.Object[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Implementation of RetriableCommand::doExecute().
- This is the actual copy-implementation.
- @param arguments Argument-list to the command.
- @return Number of bytes copied.
- @throws Exception: CopyReadException, if there are read-failures. All other
- failures are IOExceptions.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class extends RetriableCommand to implement the copy of files,
- with retries on failure.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.RetriableFileCopyCommand -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.RetriableFileCopyCommand.CopyReadException -->
- <class name="RetriableFileCopyCommand.CopyReadException" extends="java.io.IOException"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetriableFileCopyCommand.CopyReadException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Special subclass of IOException. This is used to distinguish read-operation
- failures from other kinds of IOExceptions.
- The failure to read from source is dealt with specially, in the CopyMapper.
- Such failures may be skipped if the DistCpOptions indicate so.
- Write failures are intolerable, and amount to CopyMapper failure.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.RetriableFileCopyCommand.CopyReadException -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.UniformSizeInputFormat -->
- <class name="UniformSizeInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UniformSizeInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of InputFormat::getSplits(). Returns a list of InputSplits,
- such that the number of bytes to be copied for all the splits are
- approximately equal.
- @param context JobContext for the job.
- @return The list of uniformly-distributed input-splits.
- @throws IOException: On failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of InputFormat::createRecordReader().
- @param split The split for which the RecordReader is sought.
- @param context The context of the current task-attempt.
- @return A SequenceFileRecordReader instance, (since the copy-listing is a
- simple sequence-file.)
- @throws IOException
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[UniformSizeInputFormat extends the InputFormat<> class, to produce
- input-splits for DistCp.
- It looks at the copy-listing and groups the contents into input-splits such
- that the total-number of bytes to be copied for each input split is
- uniform.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.UniformSizeInputFormat -->
- </package>
- <package name="org.apache.hadoop.tools.distcp2.mapred.lib">
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.lib.DynamicInputFormat -->
- <class name="DynamicInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DynamicInputFormat"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSplits" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of InputFormat::getSplits(). This method splits up the
- copy-listing file into chunks, and assigns the first batch to different
- tasks.
- @param jobContext JobContext for the map job.
- @return The list of (empty) dynamic input-splits.
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="taskAttemptContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of Inputformat::createRecordReader().
- @param inputSplit The split for which the RecordReader is required.
- @param taskAttemptContext TaskAttemptContext for the current attempt.
- @return DynamicRecordReader instance.
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[DynamicInputFormat implements the "Worker pattern" for DistCp.
- Rather than to split up the copy-list into a set of static splits,
- the DynamicInputFormat does the following:
- 1. Splits the copy-list into small chunks on the DFS.
- 2. Creates a set of empty "dynamic" splits, that each consume as many chunks
- as it can.
- This arrangement ensures that a single slow mapper won't slow down the entire
- job (since the slack will be picked up by other mappers, who consume more
- chunks.)
- By varying the split-ratio, one can vary chunk sizes to achieve different
- performance characteristics.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.lib.DynamicInputFormat -->
- <!-- start class org.apache.hadoop.tools.distcp2.mapred.lib.DynamicRecordReader -->
- <class name="DynamicRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DynamicRecordReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="initialize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="inputSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
- <param name="taskAttemptContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation for RecordReader::initialize(). Initializes the internal
- RecordReader to read from chunks.
- @param inputSplit The InputSplit for the map. Ignored entirely.
- @param taskAttemptContext The AttemptContext.
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="nextKeyValue" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of RecordReader::nextValue().
- Reads the contents of the current chunk and returns them. When a chunk has
- been completely exhausted, an new chunk is acquired and read,
- transparently.
- @return True, if the nextValue() could be traversed to. False, otherwise.
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getCurrentKey" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of RecordReader::getCurrentKey().
- @return The key of the current record. (i.e. the source-path.)
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getCurrentValue" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of RecordReader::getCurrentValue().
- @return The value of the current record. (i.e. the target-path.)
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <exception name="InterruptedException" type="java.lang.InterruptedException"/>
- <doc>
- <![CDATA[Implementation of RecordReader::getProgress().
- @return A fraction [0.0,1.0] indicating the progress of a DistCp mapper.
- @throws IOException, on failure.
- @throws InterruptedException]]>
- </doc>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Implementation of RecordReader::close().
- Closes the RecordReader.
- @throws IOException, on failure.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The DynamicRecordReader is used in conjunction with the DynamicInputFormat
- to implement the "Worker pattern" for DistCp.
- The DynamicRecordReader is responsible for:
- 1. Presenting the contents of each chunk to DistCp's mapper.
- 2. Acquiring a new chunk when the current chunk has been completely consumed,
- transparently.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.mapred.lib.DynamicRecordReader -->
- </package>
- <package name="org.apache.hadoop.tools.distcp2.util">
- <!-- start class org.apache.hadoop.tools.distcp2.util.DistCpUtils -->
- <class name="DistCpUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DistCpUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getFileSize" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Retrieves size of the file at the specified path.
- @param path The path of the file whose size is sought.
- @param configuration Configuration, to retrieve the appropriate FileSystem.
- @return The file-size, in number of bytes.
- @throws IOException, on failure.]]>
- </doc>
- </method>
- <method name="publish"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <param name="label" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Utility to publish a value to a configuration.
- @param configuration The Configuration to which the value must be written.
- @param label The label for the value being published.
- @param value The value being published.
- @param <T> The type of the value.]]>
- </doc>
- </method>
- <method name="getInt" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <param name="label" type="java.lang.String"/>
- <doc>
- <![CDATA[Utility to retrieve a specified key from a Configuration. Throw exception
- if not found.
- @param configuration The Configuration in which the key is sought.
- @param label The key being sought.
- @return Integer value of the key.]]>
- </doc>
- </method>
- <method name="getNumMapTasks" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <method name="getLong" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="configuration" type="org.apache.hadoop.conf.Configuration"/>
- <param name="label" type="java.lang.String"/>
- <doc>
- <![CDATA[Utility to retrieve a specified key from a Configuration. Throw exception
- if not found.
- @param configuration The Configuration in which the key is sought.
- @param label The key being sought.
- @return Long value of the key.]]>
- </doc>
- </method>
- <method name="getStrategy" return="java.lang.Class"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="options" type="org.apache.hadoop.tools.distcp2.DistCpOptions"/>
- <doc>
- <![CDATA[Returns the class that implements a copy strategy. Looks up the implementation for
- a particular strategy from distcp-default.xml
- @param conf - Configuration object
- @param options - Handle to input options
- @return Class implementing the strategy specified in options.]]>
- </doc>
- </method>
- <method name="getRelativePath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sourceRootPath" type="org.apache.hadoop.fs.Path"/>
- <param name="childPath" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Gets relative path of child path with respect to a root path
- For ex. If childPath = /tmp/abc/xyz/file and
- sourceRootPath = /tmp/abc
- Relative path would be /xyz/file
- If childPath = /file and
- sourceRootPath = /
- Relative path would be /file
- @param sourceRootPath - Source root path
- @param childPath - Path for which relative path is required
- @return - Relative portion of the child path (always prefixed with /
- unless it is empty]]>
- </doc>
- </method>
- <method name="packAttributes" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[Pack file preservation attributes into a string, containing
- just the first character of each preservation attribute
- @param attributes - Attribute set to preserve
- @return - String containing first letters of each attribute to preserve]]>
- </doc>
- </method>
- <method name="unpackAttributes" return="java.util.EnumSet"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.lang.String"/>
- <doc>
- <![CDATA[Un packs preservation attribute string containing the first character of
- each preservation attribute back to a set of attributes to preserve
- @param attributes - Attribute string
- @return - Attribute set]]>
- </doc>
- </method>
- <method name="preserve"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="targetFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="srcFileStatus" type="org.apache.hadoop.fs.FileStatus"/>
- <param name="attributes" type="java.util.EnumSet"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Preserve attribute on file matching that of the file status being sent
- as argument. Barring the block size, all the other attributes are preserved
- by this function
- @param targetFS - File system
- @param path - Path that needs to preserve original file status
- @param srcFileStatus - Original file status
- @param attributes - Attribute set that need to be preserved
- @throws IOException - Exception if any (particularly relating to group/owner
- change or any transient error)]]>
- </doc>
- </method>
- <method name="sortListing" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <param name="sourceListing" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Sort sequence file containing FileStatus and Text as key and value respecitvely
- @param fs - File System
- @param conf - Configuration
- @param sourceListing - Source listing file
- @return Path of the sorted file. Is source file with _sorted appended to the name
- @throws IOException - Any exception during sort.]]>
- </doc>
- </method>
- <method name="getFormatter" return="java.text.DecimalFormat"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStringDescriptionFor" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nBytes" type="long"/>
- </method>
- <method name="checksumsAreEqual" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="sourceFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="source" type="org.apache.hadoop.fs.Path"/>
- <param name="targetFS" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="target" type="org.apache.hadoop.fs.Path"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Utility to compare checksums for the paths specified.
- If checksums's can't be retrieved, it doesn't fail the test
- Only time the comparison would fail is when checksums are
- available and they don't match
-
- @param sourceFS FileSystem for the source path.
- @param source The source path.
- @param targetFS FileSystem for the target path.
- @param target The target path.
- @return If either checksum couldn't be retrieved, the function returns
- false. If checksums are retrieved, the function returns true if they match,
- and false otherwise.
- @throws IOException if there's an exception while retrieving checksums.]]>
- </doc>
- </method>
- <method name="compareFs" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="srcFs" type="org.apache.hadoop.fs.FileSystem"/>
- <param name="destFs" type="org.apache.hadoop.fs.FileSystem"/>
- </method>
- <doc>
- <![CDATA[Utility functions used in DistCp.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.util.DistCpUtils -->
- <!-- start class org.apache.hadoop.tools.distcp2.util.RetriableCommand -->
- <class name="RetriableCommand" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RetriableCommand" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- @param description The human-readable description of the command.]]>
- </doc>
- </constructor>
- <constructor name="RetriableCommand" type="java.lang.String, org.apache.hadoop.io.retry.RetryPolicy"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
- @param description The human-readable description of the command.
- @param retryPolicy The RetryHandler to be used to compute retries.]]>
- </doc>
- </constructor>
- <method name="doExecute" return="java.lang.Object"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="arguments" type="java.lang.Object[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[Implement this interface-method define the command-logic that will be
- retried on failure (i.e. with Exception).
- @param arguments Argument-list to the command.
- @return Generic "Object".
- @throws Exception Throws Exception on complete failure.]]>
- </doc>
- </method>
- <method name="execute" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arguments" type="java.lang.Object[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- <doc>
- <![CDATA[The execute() method invokes doExecute() until either:
- 1. doExecute() succeeds, or
- 2. the command may no longer be retried (e.g. runs out of retry-attempts).
- @param arguments The list of arguments for the command.
- @return Generic "Object" from doExecute(), on success.
- @throws IOException, IOException, on complete failure.]]>
- </doc>
- </method>
- <method name="setRetryPolicy" return="org.apache.hadoop.tools.distcp2.util.RetriableCommand"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="retryHandler" type="org.apache.hadoop.io.retry.RetryPolicy"/>
- <doc>
- <![CDATA[Fluent-interface to change the RetryHandler.
- @param retryHandler The new RetryHandler instance to be used.
- @return Self.]]>
- </doc>
- </method>
- <field name="description" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class represents commands that be retried on failure, in a configurable
- manner.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.util.RetriableCommand -->
- <!-- start class org.apache.hadoop.tools.distcp2.util.ThrottledInputStream -->
- <class name="ThrottledInputStream" extends="java.io.InputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ThrottledInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ThrottledInputStream" type="java.io.InputStream, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="b" type="byte[]"/>
- <param name="off" type="int"/>
- <param name="len" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <method name="getTotalBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter for the number of bytes read from this stream, since creation.
- @return The number of bytes.]]>
- </doc>
- </method>
- <method name="getBytesPerSec" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter for the read-rate from this stream, since creation.
- Calculated as bytesRead/elapsedTimeSinceStart.
- @return Read rate, in bytes/sec.]]>
- </doc>
- </method>
- <method name="getTotalSleepTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getter the total time spent in sleep.
- @return Number of milliseconds spent in sleep.]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@inheritDoc]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The ThrottleInputStream provides bandwidth throttling on a specified
- InputStream. It is implemented as a wrapper on top of another InputStream
- instance.
- The throttling works by examining the number of bytes read from the underlying
- InputStream from the beginning, and sleep()ing for a time interval if
- the byte-transfer is found exceed the specified tolerable maximum.
- (Thus, while the read-rate might exceed the maximum for a given short interval,
- the average tends towards the specified maximum, overall.)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.distcp2.util.ThrottledInputStream -->
- </package>
- <package name="org.apache.hadoop.tools.rumen">
- <!-- start class org.apache.hadoop.tools.rumen.AbstractClusterStory -->
- <class name="AbstractClusterStory" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.ClusterStory"/>
- <constructor name="AbstractClusterStory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMachines" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRacks" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRandomMachines" return="org.apache.hadoop.tools.rumen.MachineNode[]"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expected" type="int"/>
- <param name="random" type="java.util.Random"/>
- </method>
- <method name="buildMachineNodeMap"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getMachineByName" return="org.apache.hadoop.tools.rumen.MachineNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="distance" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.tools.rumen.Node"/>
- <param name="b" type="org.apache.hadoop.tools.rumen.Node"/>
- </method>
- <method name="buildRackNodeMap"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="getRackByName" return="org.apache.hadoop.tools.rumen.RackNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getMaximumDistance" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="parseTopologyTree"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="machineNodes" type="java.util.Set"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rackNodes" type="java.util.Set"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="mNodesFlattened" type="org.apache.hadoop.tools.rumen.MachineNode[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="mNodeMap" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="rNodeMap" type="java.util.Map"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="maximumDistance" type="int"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[{@link AbstractClusterStory} provides a partial implementation of
- {@link ClusterStory} by parsing the topology tree.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.AbstractClusterStory -->
- <!-- start class org.apache.hadoop.tools.rumen.CDFPiecewiseLinearRandomGenerator -->
- <class name="CDFPiecewiseLinearRandomGenerator" extends="org.apache.hadoop.tools.rumen.CDFRandomGenerator"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CDFPiecewiseLinearRandomGenerator" type="org.apache.hadoop.tools.rumen.LoggedDiscreteCDF"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param cdf
- builds a CDFRandomValue engine around this
- {@link LoggedDiscreteCDF}, with a defaultly seeded RNG]]>
- </doc>
- </constructor>
- <constructor name="CDFPiecewiseLinearRandomGenerator" type="org.apache.hadoop.tools.rumen.LoggedDiscreteCDF, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param cdf
- builds a CDFRandomValue engine around this
- {@link LoggedDiscreteCDF}, with an explicitly seeded RNG
- @param seed
- the random number generator seed]]>
- </doc>
- </constructor>
- <method name="valueAt" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="probability" type="double"/>
- <doc>
- <![CDATA[TODO This code assumes that the empirical minimum resp. maximum is the
- epistomological minimum resp. maximum. This is probably okay for the
- minimum, because that likely represents a task where everything went well,
- but for the maximum we may want to develop a way of extrapolating past the
- maximum.]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.CDFPiecewiseLinearRandomGenerator -->
- <!-- start class org.apache.hadoop.tools.rumen.CDFRandomGenerator -->
- <class name="CDFRandomGenerator" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="initializeTables"
- abstract="false" native="false" synchronized="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- <param name="cdf" type="org.apache.hadoop.tools.rumen.LoggedDiscreteCDF"/>
- </method>
- <method name="floorIndex" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="probe" type="double"/>
- </method>
- <method name="getRankingAt" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="index" type="int"/>
- </method>
- <method name="getDatumAt" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="index" type="int"/>
- </method>
- <method name="randomValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueAt" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="probability" type="double"/>
- </method>
- <doc>
- <![CDATA[An instance of this class generates random values that confirm to the
- embedded {@link LoggedDiscreteCDF} . The discrete CDF is a pointwise
- approximation of the "real" CDF. We therefore have a choice of interpolation
- rules.
-
- A concrete subclass of this abstract class will implement valueAt(double)
- using a class-dependent interpolation rule.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.CDFRandomGenerator -->
- <!-- start interface org.apache.hadoop.tools.rumen.ClusterStory -->
- <interface name="ClusterStory" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getMachines" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all machines of the cluster.
- @return A read-only set that contains all machines of the cluster.]]>
- </doc>
- </method>
- <method name="getRacks" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all racks of the cluster.
- @return A read-only set that contains all racks of the cluster.]]>
- </doc>
- </method>
- <method name="getClusterTopology" return="org.apache.hadoop.tools.rumen.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the cluster topology tree.
- @return The root node of the cluster topology tree.]]>
- </doc>
- </method>
- <method name="getRandomMachines" return="org.apache.hadoop.tools.rumen.MachineNode[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expected" type="int"/>
- <param name="random" type="java.util.Random"/>
- <doc>
- <![CDATA[Select a random set of machines.
- @param expected The expected sample size.
- @param random Random number generator to use.
- @return An array of up to expected number of {@link MachineNode}s.]]>
- </doc>
- </method>
- <method name="getMachineByName" return="org.apache.hadoop.tools.rumen.MachineNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get {@link MachineNode} by its host name.
-
- @return The {@link MachineNode} with the same name. Or null if not found.]]>
- </doc>
- </method>
- <method name="getRackByName" return="org.apache.hadoop.tools.rumen.RackNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Get {@link RackNode} by its name.
- @return The {@link RackNode} with the same name. Or null if not found.]]>
- </doc>
- </method>
- <method name="distance" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="a" type="org.apache.hadoop.tools.rumen.Node"/>
- <param name="b" type="org.apache.hadoop.tools.rumen.Node"/>
- <doc>
- <![CDATA[Determine the distance between two {@link Node}s. Currently, the distance
- is loosely defined as the length of the longer path for either a or b to
- reach their common ancestor.
-
- @param a
- @param b
- @return The distance between {@link Node} a and {@link Node} b.]]>
- </doc>
- </method>
- <method name="getMaximumDistance" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum distance possible between any two nodes.
- @return the maximum distance possible between any two nodes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ClusterStory} represents all configurations of a MapReduce cluster,
- including nodes, network topology, and slot configurations.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.ClusterStory -->
- <!-- start class org.apache.hadoop.tools.rumen.ClusterTopologyReader -->
- <class name="ClusterTopologyReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClusterTopologyReader" type="org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor.
-
- @param path
- Path to the JSON-encoded topology file, possibly compressed.
- @param conf
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ClusterTopologyReader" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor.
-
- @param input
- The input stream for the JSON-encoded topology data.]]>
- </doc>
- </constructor>
- <method name="get" return="org.apache.hadoop.tools.rumen.LoggedNetworkTopology"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link LoggedNetworkTopology} object.
-
- @return The {@link LoggedNetworkTopology} object parsed from the input.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Reading JSON-encoded cluster topology and produce the parsed
- {@link LoggedNetworkTopology} object.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ClusterTopologyReader -->
- <!-- start interface org.apache.hadoop.tools.rumen.DeepCompare -->
- <interface name="DeepCompare" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="myLocation" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- <doc>
- <![CDATA[@param other
- the other comparand that's being compared to me
- @param myLocation
- the path that got to me. In the root, myLocation is null. To
- process the scalar {@code foo} field of the root we will make a
- recursive call with a {@link TreePath} whose {@code fieldName} is
- {@code "bar"} and whose {@code index} is -1 and whose {@code
- parent} is {@code null}. To process the plural {@code bar} field
- of the root we will make a recursive call with a {@link TreePath}
- whose fieldName is {@code "foo"} and whose {@code index} is -1 and
- whose {@code parent} is also {@code null}.
- @throws DeepInequalityException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Classes that implement this interface can deep-compare [for equality only,
- not order] with another instance. They do a deep compare. If there is any
- semantically significant difference, an implementer throws an Exception to be
- thrown with a chain of causes describing the chain of field references and
- indices that get you to the miscompared point.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.DeepCompare -->
- <!-- start class org.apache.hadoop.tools.rumen.DeepInequalityException -->
- <class name="DeepInequalityException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="DeepInequalityException" type="java.lang.String, org.apache.hadoop.tools.rumen.TreePath, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param message
- an exception message
- @param path
- the path that gets from the root to the inequality
-
- This is the constructor that I intend to have used for this
- exception.]]>
- </doc>
- </constructor>
- <constructor name="DeepInequalityException" type="java.lang.String, org.apache.hadoop.tools.rumen.TreePath"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param message
- an exception message
- @param path
- the path that gets from the root to the inequality
-
- This is the constructor that I intend to have used for this
- exception.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[We use this exception class in the unit test, and we do a deep comparison
- when we run the]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.DeepInequalityException -->
- <!-- start class org.apache.hadoop.tools.rumen.DefaultInputDemuxer -->
- <class name="DefaultInputDemuxer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.InputDemuxer"/>
- <constructor name="DefaultInputDemuxer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="bindTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="getNext" return="org.apache.hadoop.tools.rumen.Pair"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[{@link DefaultInputDemuxer} acts as a pass-through demuxer. It just opens
- each file and returns back the input stream. If the input is compressed, it
- would return a decompression stream.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.DefaultInputDemuxer -->
- <!-- start class org.apache.hadoop.tools.rumen.DefaultOutputter -->
- <class name="DefaultOutputter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.Outputter"/>
- <constructor name="DefaultOutputter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="output"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="object" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[The default {@link Outputter} that outputs to a plain file. Compression
- will be applied if the path has the right suffix.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.DefaultOutputter -->
- <!-- start class org.apache.hadoop.tools.rumen.DeskewedJobTraceReader -->
- <class name="DeskewedJobTraceReader" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="DeskewedJobTraceReader" type="org.apache.hadoop.tools.rumen.JobTraceReader, int, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor.
-
- @param reader
- the {@link JobTraceReader} that's being protected
- @param skewBufferLength
- [the number of late jobs that can preced a later out-of-order
- earlier job
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="DeskewedJobTraceReader" type="org.apache.hadoop.tools.rumen.JobTraceReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.DeskewedJobTraceReader -->
- <!-- start class org.apache.hadoop.tools.rumen.EventType -->
- <class name="EventType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.EventType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="JOB_SUBMITTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_INITED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_PRIORITY_CHANGED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_STATUS_CHANGED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_KILLED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_INFO_CHANGED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_STARTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_UPDATED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_ATTEMPT_STARTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_ATTEMPT_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_ATTEMPT_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_ATTEMPT_KILLED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_ATTEMPT_STARTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_ATTEMPT_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_ATTEMPT_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_ATTEMPT_KILLED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP_ATTEMPT_STARTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP_ATTEMPT_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP_ATTEMPT_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP_ATTEMPT_KILLED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP_ATTEMPT_STARTED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP_ATTEMPT_FINISHED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP_ATTEMPT_FAILED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP_ATTEMPT_KILLED" type="org.apache.hadoop.tools.rumen.EventType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.EventType -->
- <!-- start class org.apache.hadoop.tools.rumen.Hadoop20JHParser -->
- <class name="Hadoop20JHParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.JobHistoryParser"/>
- <constructor name="Hadoop20JHParser" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <constructor name="Hadoop20JHParser" type="org.apache.hadoop.util.LineReader"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="canParse" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="input" type="java.io.InputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Can this parser parse the input?
-
- @param input
- @return Whether this parser can parse the input.
- @throws IOException
-
- We will deem a stream to be a good 0.20 job history stream if the
- first line is exactly "Meta VERSION=\"1\" ."]]>
- </doc>
- </method>
- <method name="nextEvent" return="org.apache.hadoop.tools.rumen.HistoryEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[{@link JobHistoryParser} to parse job histories for hadoop 0.20 (META=1).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Hadoop20JHParser -->
- <!-- start class org.apache.hadoop.tools.rumen.HadoopLogsAnalyzer -->
- <class name="HadoopLogsAnalyzer" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="HadoopLogsAnalyzer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <doc>
- <![CDATA[@param args
-
- Last arg is the input file. That file can be a directory, in which
- case you get all the files in sorted order. We will decompress
- files whose nmes end in .gz .
-
- switches: -c collect line types.
-
- -d debug mode
-
- -delays print out the delays [interval between job submit time and
- launch time]
-
- -runtimes print out the job runtimes
-
- -spreads print out the ratio of 10%ile and 90%ile, of both the
- successful map task attempt run times and the the successful
- reduce task attempt run times
-
- -tasktimes prints out individual task time distributions
-
- collects all the line types and prints the first example of each
- one]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is the main class for rumen log mining functionality.
-
- It reads a directory of job tracker logs, and computes various information
- about it. See {@code usage()}, below.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.HadoopLogsAnalyzer -->
- <!-- start interface org.apache.hadoop.tools.rumen.HistoryEvent -->
- <interface name="HistoryEvent" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return this event's type.]]>
- </doc>
- </method>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.HistoryEvent -->
- <!-- start interface org.apache.hadoop.tools.rumen.InputDemuxer -->
- <interface name="InputDemuxer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="bindTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Bind the {@link InputDemuxer} to a particular file.
-
- @param path
- The path to the find it should bind to.
- @param conf
- Configuration
- @throws IOException
-
- Returns true when the binding succeeds. If the file can be read
- but is in the wrong format, returns false. IOException is
- reserved for read errors.]]>
- </doc>
- </method>
- <method name="getNext" return="org.apache.hadoop.tools.rumen.Pair"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the next <name, input> pair. The name should preserve the original job
- history file or job conf file name. The input object should be closed
- before calling getNext() again. The old input object would be invalid after
- calling getNext() again.
-
- @return the next <name, input> pair.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link InputDemuxer} dem-ultiplexes the input files into individual input
- streams.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.InputDemuxer -->
- <!-- start class org.apache.hadoop.tools.rumen.JhCounter -->
- <class name="JhCounter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JhCounter"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="name" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="displayName" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="value" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JhCounter -->
- <!-- start class org.apache.hadoop.tools.rumen.JhCounterGroup -->
- <class name="JhCounterGroup" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JhCounterGroup"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="name" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="displayName" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="counts" type="java.util.List"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JhCounterGroup -->
- <!-- start class org.apache.hadoop.tools.rumen.JhCounters -->
- <class name="JhCounters" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="name" type="java.lang.String"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="groups" type="java.util.List"
- transient="false" volatile="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JhCounters -->
- <!-- start class org.apache.hadoop.tools.rumen.Job20LineHistoryEventEmitter -->
- <class name="Job20LineHistoryEventEmitter" extends="org.apache.hadoop.tools.rumen.HistoryEventEmitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Job20LineHistoryEventEmitter -->
- <!-- start class org.apache.hadoop.tools.rumen.JobBuilder -->
- <class name="JobBuilder" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobBuilder" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <doc>
- <![CDATA[Process one {@link HistoryEvent}
-
- @param event
- The {@link HistoryEvent} to be processed.]]>
- </doc>
- </method>
- <method name="process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="java.util.Properties"/>
- <doc>
- <![CDATA[Process a collection of JobConf {@link Properties}. We do not restrict it
- to be called once. It is okay to process a conf before, during or after the
- events.
-
- @param conf
- The job conf properties to be added.]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.tools.rumen.ParsedJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Request the builder to build the final object. Once called, the
- {@link JobBuilder} would accept no more events or job-conf properties.
-
- @return Parsed {@link ParsedJob} object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link JobBuilder} builds one job. It processes a sequence of
- {@link HistoryEvent}s.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobBuilder -->
- <!-- start class org.apache.hadoop.tools.rumen.JobConfigurationParser -->
- <class name="JobConfigurationParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobConfigurationParser"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[{@link JobConfigurationParser} parses the job configuration xml file, and
- extracts configuration properties. It parses the file using a
- stream-parser and thus is more memory efficient. [This optimization may be
- postponed for a future release]]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobConfigurationParser -->
- <!-- start class org.apache.hadoop.tools.rumen.JobConfPropertyNames -->
- <class name="JobConfPropertyNames" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.JobConfPropertyNames[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getCandidates" return="java.lang.String[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="QUEUE_NAMES" type="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="JOB_NAMES" type="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TASK_JAVA_OPTS_S" type="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP_JAVA_OPTS_S" type="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE_JAVA_OPTS_S" type="org.apache.hadoop.tools.rumen.JobConfPropertyNames"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobConfPropertyNames -->
- <!-- start class org.apache.hadoop.tools.rumen.JobFinishedEvent -->
- <class name="JobFinishedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobFinishedEvent" type="org.apache.hadoop.mapreduce.JobID, long, int, int, int, int, org.apache.hadoop.mapreduce.Counters, org.apache.hadoop.mapreduce.Counters, org.apache.hadoop.mapreduce.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record successful job completion
- @param id Job ID
- @param finishTime Finish time of the job
- @param finishedMaps The number of finished maps
- @param finishedReduces The number of finished reduces
- @param failedMaps The number of failed maps
- @param failedReduces The number of failed reduces
- @param mapCounters Map Counters for the job
- @param reduceCounters Reduce Counters for the job
- @param totalCounters Total Counters for the job]]>
- </doc>
- </constructor>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobid" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job ID]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job finish time]]>
- </doc>
- </method>
- <method name="getFinishedMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of finished maps for the job]]>
- </doc>
- </method>
- <method name="getFinishedReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of finished reducers for the job]]>
- </doc>
- </method>
- <method name="getFailedMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of failed maps for the job]]>
- </doc>
- </method>
- <method name="getFailedReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of failed reducers for the job]]>
- </doc>
- </method>
- <method name="getTotalCounters" return="org.apache.hadoop.mapreduce.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the counters for the job]]>
- </doc>
- </method>
- <method name="getMapCounters" return="org.apache.hadoop.mapreduce.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Map counters for the job]]>
- </doc>
- </method>
- <method name="getReduceCounters" return="org.apache.hadoop.mapreduce.Counters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reduce counters for the job]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record successful completion of job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobFinishedEvent -->
- <!-- start interface org.apache.hadoop.tools.rumen.JobHistoryParser -->
- <interface name="JobHistoryParser" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="nextEvent" return="org.apache.hadoop.tools.rumen.HistoryEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the next {@link HistoryEvent}
- @return the next {@link HistoryEvent}. If no more events left, return null.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link JobHistoryParser} defines the interface of a Job History file parser.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.JobHistoryParser -->
- <!-- start class org.apache.hadoop.tools.rumen.JobHistoryParserFactory -->
- <class name="JobHistoryParserFactory" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistoryParserFactory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getParser" return="org.apache.hadoop.tools.rumen.JobHistoryParser"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ris" type="org.apache.hadoop.tools.rumen.RewindableInputStream"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[{@link JobHistoryParserFactory} is a singleton class that attempts to
- determine the version of job history and return a proper parser.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobHistoryParserFactory -->
- <!-- start class org.apache.hadoop.tools.rumen.JobHistoryParserFactory.VersionDetector -->
- <class name="JobHistoryParserFactory.VersionDetector" extends="java.lang.Enum"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.JobHistoryParserFactory.VersionDetector[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.JobHistoryParserFactory.VersionDetector"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="Hadoop20" type="org.apache.hadoop.tools.rumen.JobHistoryParserFactory.VersionDetector"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobHistoryParserFactory.VersionDetector -->
- <!-- start class org.apache.hadoop.tools.rumen.JobHistoryUtils -->
- <class name="JobHistoryUtils" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobHistoryUtils"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobHistoryUtils -->
- <!-- start class org.apache.hadoop.tools.rumen.JobInfoChangeEvent -->
- <class name="JobInfoChangeEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobInfoChangeEvent" type="org.apache.hadoop.mapreduce.JobID, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create a event to record the submit and launch time of a job
- @param id Job Id
- @param submitTime Submit time of the job
- @param launchTime Launch time of the job]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job ID]]>
- </doc>
- </method>
- <method name="getSubmitTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job submit time]]>
- </doc>
- </method>
- <method name="getLaunchTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job launch time]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Event to record changes in the submit and launch time of
- a job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobInfoChangeEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.JobInitedEvent -->
- <class name="JobInitedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobInitedEvent" type="org.apache.hadoop.mapreduce.JobID, long, int, int, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record job initialization
- @param id
- @param launchTime
- @param totalMaps
- @param totalReduces
- @param jobStatus]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job ID]]>
- </doc>
- </method>
- <method name="getLaunchTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the launch time]]>
- </doc>
- </method>
- <method name="getTotalMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of maps]]>
- </doc>
- </method>
- <method name="getTotalReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total number of reduces]]>
- </doc>
- </method>
- <method name="getStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the initialization of a job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobInitedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.JobPriorityChangeEvent -->
- <class name="JobPriorityChangeEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobPriorityChangeEvent" type="org.apache.hadoop.mapreduce.JobID, org.apache.hadoop.mapred.JobPriority"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Generate an event to record changes in Job priority
- @param id Job Id
- @param priority The new priority of the job]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job ID]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.mapred.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job priority]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the change of priority of a job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobPriorityChangeEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.JobStatusChangedEvent -->
- <class name="JobStatusChangedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobStatusChangedEvent" type="org.apache.hadoop.mapreduce.JobID, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record the change in the Job Status
- @param id Job ID
- @param jobStatus The new job status]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job Id]]>
- </doc>
- </method>
- <method name="getStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the change of status for a job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobStatusChangedEvent -->
- <!-- start interface org.apache.hadoop.tools.rumen.JobStory -->
- <interface name="JobStory" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link JobConf} for the job.
- @return the <code>JobConf</code> for the job]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job name.
- @return the job name]]>
- </doc>
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job ID
- @return the job ID]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user who ran the job.
- @return the user who ran the job]]>
- </doc>
- </method>
- <method name="getSubmissionTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job submission time.
- @return the job submission time]]>
- </doc>
- </method>
- <method name="getNumberMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of maps in the {@link JobStory}.
- @return the number of maps in the <code>Job</code>]]>
- </doc>
- </method>
- <method name="getNumberReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of reduce in the {@link JobStory}.
- @return the number of reduces in the <code>Job</code>]]>
- </doc>
- </method>
- <method name="getInputSplits" return="org.apache.hadoop.mapreduce.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the input splits for the job.
- @return the input splits for the job]]>
- </doc>
- </method>
- <method name="getTaskInfo" return="org.apache.hadoop.tools.rumen.TaskInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="taskNumber" type="int"/>
- <doc>
- <![CDATA[Get {@link TaskInfo} for a given task.
- @param taskType {@link TaskType} of the task
- @param taskNumber Partition number of the task
- @return the <code>TaskInfo</code> for the given task]]>
- </doc>
- </method>
- <method name="getTaskAttemptInfo" return="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="taskNumber" type="int"/>
- <param name="taskAttemptNumber" type="int"/>
- <doc>
- <![CDATA[Get {@link TaskAttemptInfo} for a given task-attempt, without regard to
- impact of locality (e.g. not needed to make scheduling decisions).
- @param taskType {@link TaskType} of the task-attempt
- @param taskNumber Partition number of the task-attempt
- @param taskAttemptNumber Attempt number of the task
- @return the <code>TaskAttemptInfo</code> for the given task-attempt]]>
- </doc>
- </method>
- <method name="getMapTaskAttemptInfoAdjusted" return="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskNumber" type="int"/>
- <param name="taskAttemptNumber" type="int"/>
- <param name="locality" type="int"/>
- <doc>
- <![CDATA[Get {@link TaskAttemptInfo} for a given task-attempt, considering impact
- of locality.
- @param taskNumber Partition number of the task-attempt
- @param taskAttemptNumber Attempt number of the task
- @param locality Data locality of the task as scheduled in simulation
- @return the <code>TaskAttemptInfo</code> for the given task-attempt]]>
- </doc>
- </method>
- <method name="getOutcome" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the outcome of the job execution.
- @return The outcome of the job execution.]]>
- </doc>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the queue where the job is submitted.
- @return the queue where the job is submitted.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link JobStory} represents the runtime information available for a
- completed Map-Reduce job.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.JobStory -->
- <!-- start interface org.apache.hadoop.tools.rumen.JobStoryProducer -->
- <interface name="JobStoryProducer" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="getNextJob" return="org.apache.hadoop.tools.rumen.JobStory"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get the next job.
- @return The next job. Or null if no more job is available.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link JobStoryProducer} produces the sequence of {@link JobStory}'s.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.JobStoryProducer -->
- <!-- start class org.apache.hadoop.tools.rumen.JobSubmittedEvent -->
- <class name="JobSubmittedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobSubmittedEvent" type="org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, long, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.">
- <doc>
- <![CDATA[@deprecated Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.]]>
- </doc>
- </constructor>
- <constructor name="JobSubmittedEvent" type="org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, long, java.lang.String, java.util.Map"
- static="false" final="false" visibility="public"
- deprecated="Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.">
- <doc>
- <![CDATA[@deprecated Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.]]>
- </doc>
- </constructor>
- <constructor name="JobSubmittedEvent" type="org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, long, java.lang.String, java.util.Map, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.">
- <doc>
- <![CDATA[@deprecated Use
- {@link #JobSubmittedEvent(JobID, String, String, long, String,
- Map, String, String, String, String, String, String)}
- instead.]]>
- </doc>
- </constructor>
- <constructor name="JobSubmittedEvent" type="org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, long, java.lang.String, java.util.Map, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record job submission
- @param id The job Id of the job
- @param jobName Name of the job
- @param userName Name of the user who submitted the job
- @param submitTime Time of submission
- @param jobConfPath Path of the Job Configuration file
- @param jobACLs The configured acls for the job.
- @param queue job queue name
- @param workflowId the workflow Id
- @param workflowName the workflow name
- @param workflowNodeName the workflow node name
- @param workflowAdjacencies the workflow adjacencies
- @param workflowTags Comma-separated workflow tags]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job Id]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job name]]>
- </doc>
- </method>
- <method name="getUserName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user name]]>
- </doc>
- </method>
- <method name="getSubmitTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the submit time]]>
- </doc>
- </method>
- <method name="getJobConfPath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Path for the Job Configuration file]]>
- </doc>
- </method>
- <method name="getJobAcls" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the acls configured for the job]]>
- </doc>
- </method>
- <method name="getJobQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the acls configured for the job]]>
- </doc>
- </method>
- <method name="getWorkflowId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the workflow Id]]>
- </doc>
- </method>
- <method name="getWorkflowName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the workflow name]]>
- </doc>
- </method>
- <method name="getWorkflowNodeName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the workflow node name]]>
- </doc>
- </method>
- <method name="getWorkflowAdjacencies" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the workflow adjacencies]]>
- </doc>
- </method>
- <method name="getWorkflowTags" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the workflow tags]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the submission of a job]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobSubmittedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.JobTraceReader -->
- <class name="JobTraceReader" extends="org.apache.hadoop.tools.rumen.JsonObjectMapperParser"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="JobTraceReader" type="org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor.
-
- @param path
- Path to the JSON trace file, possibly compressed.
- @param conf
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="JobTraceReader" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor.
-
- @param input
- The input stream for the JSON trace.]]>
- </doc>
- </constructor>
- <doc>
- <![CDATA[Reading JSON-encoded job traces and produce {@link LoggedJob} instances.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobTraceReader -->
- <!-- start class org.apache.hadoop.tools.rumen.JobUnsuccessfulCompletionEvent -->
- <class name="JobUnsuccessfulCompletionEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="JobUnsuccessfulCompletionEvent" type="org.apache.hadoop.mapreduce.JobID, long, int, int, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record unsuccessful completion (killed/failed) of jobs
- @param id Job ID
- @param finishTime Finish time of the job
- @param finishedMaps Number of finished maps
- @param finishedReduces Number of finished reduces
- @param status Status of the job]]>
- </doc>
- </constructor>
- <method name="getJobId" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Job ID]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the job finish time]]>
- </doc>
- </method>
- <method name="getFinishedMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of finished maps]]>
- </doc>
- </method>
- <method name="getFinishedReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of finished reduces]]>
- </doc>
- </method>
- <method name="getStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record Failed and Killed completion of jobs]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JobUnsuccessfulCompletionEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.JsonObjectMapperWriter -->
- <class name="JsonObjectMapperWriter" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <constructor name="JsonObjectMapperWriter" type="java.io.OutputStream, boolean"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </constructor>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="object" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Simple wrapper around {@link JsonGenerator} to write objects in JSON format.
- @param <T> The type of the objects to be written.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.JsonObjectMapperWriter -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedDiscreteCDF -->
- <class name="LoggedDiscreteCDF" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <constructor name="LoggedDiscreteCDF"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMinimum" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRankings" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMaximum" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumberValues" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedDiscreteCDF} is a discrete approximation of a cumulative
- distribution function, with this class set up to meet the requirements of the
- Jackson JSON parser/generator.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedDiscreteCDF -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedJob -->
- <class name="LoggedJob" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <method name="getJobProperties" return="java.util.Properties"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configuration properties of the job.]]>
- </doc>
- </method>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPriority" return="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getComputonsPerMapInputByte" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getComputonsPerMapOutputByte" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getComputonsPerReduceInputByte" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getComputonsPerReduceOutputByte" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSubmitTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLaunchTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHeapMegabytes" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTotalMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTotalReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOutcome" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobtype" return="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDirectDependantJobs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReduceTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOtherTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSuccessfulMapAttemptCDFs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFailedMapAttemptCDFs" return="java.util.ArrayList"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSuccessfulReduceAttemptCDF" return="org.apache.hadoop.tools.rumen.LoggedDiscreteCDF"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFailedReduceAttemptCDF" return="org.apache.hadoop.tools.rumen.LoggedDiscreteCDF"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapperTriesToSucceed" return="double[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFailedMapperFraction" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getRelativeTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return job queue name if it is available in job history file or
- job history conf file. Returns null otherwise.]]>
- </doc>
- </method>
- <method name="getJobName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getClusterMapMB" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getClusterReduceMB" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobMapMB" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobReduceMB" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedDiscreteCDF} is a representation of an hadoop job, with the
- details of this class set up to meet the requirements of the Jackson JSON
- parser/generator.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedJob -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedJob.JobPriority -->
- <class name="LoggedJob.JobPriority" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="VERY_LOW" type="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOW" type="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NORMAL" type="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HIGH" type="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VERY_HIGH" type="org.apache.hadoop.tools.rumen.LoggedJob.JobPriority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedJob.JobPriority -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedJob.JobType -->
- <class name="LoggedJob.JobType" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.LoggedJob.JobType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="JAVA" type="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PIG" type="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STREAMING" type="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PIPES" type="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OVERALL" type="org.apache.hadoop.tools.rumen.LoggedJob.JobType"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedJob.JobType -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedLocation -->
- <class name="LoggedLocation" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <constructor name="LoggedLocation"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getLayers" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedLocation} is a representation of a point in an hierarchical
- network, represented as a series of membership names, broadest first.
-
- For example, if your network has <i>hosts</i> grouped into <i>racks</i>, then
- in onecluster you might have a node {@code node1} on rack {@code rack1}. This
- would be represented with a ArrayList of two layers, with two {@link String}
- s being {@code "rack1"} and {@code "node1"}.
-
- The details of this class are set up to meet the requirements of the Jackson
- JSON parser/generator.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedLocation -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedNetworkTopology -->
- <class name="LoggedNetworkTopology" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <constructor name="LoggedNetworkTopology"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getChildren" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedNetworkTopology} represents a tree that in turn represents a
- hierarchy of hosts. The current version requires the tree to have all leaves
- at the same level.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedNetworkTopology -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedSingleRelativeRanking -->
- <class name="LoggedSingleRelativeRanking" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <constructor name="LoggedSingleRelativeRanking"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="getRelativeRanking" return="double"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDatum" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedSingleRelativeRanking} represents an X-Y coordinate of a
- single point in a discrete CDF.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedSingleRelativeRanking -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedTask -->
- <class name="LoggedTask" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="getInputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOutputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOutputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAttempts" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getPreferredLocations" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskStatus" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getTaskType" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incorporateCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.tools.rumen.JhCounters"/>
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedTask} represents a [hadoop] task that is part of a hadoop job.
- It knows about the [pssibly empty] sequence of attempts, its I/O footprint,
- and its runtime.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedTask -->
- <!-- start class org.apache.hadoop.tools.rumen.LoggedTaskAttempt -->
- <class name="LoggedTaskAttempt" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <method name="setUnknownAttribute"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="ignored" type="java.lang.Object"/>
- </method>
- <method name="getShuffleFinished" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSortFinished" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAttemptID" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getResult" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHostName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHdfsBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getHdfsBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileBytesRead" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getFileBytesWritten" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapInputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapOutputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapOutputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getCombineInputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReduceInputGroups" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReduceInputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReduceShuffleBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getReduceOutputRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSpilledRecords" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLocation" return="org.apache.hadoop.tools.rumen.LoggedLocation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapInputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="incorporateCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.tools.rumen.JhCounters"/>
- </method>
- <method name="getResourceUsageMetrics" return="org.apache.hadoop.tools.rumen.ResourceUsageMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="comparand" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[A {@link LoggedTaskAttempt} represents an attempt to run an hadoop task in a
- hadoop job. Note that a task can have several attempts.
-
- All of the public methods are simply accessors for the instance variables we
- want to write out in the JSON files.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.LoggedTaskAttempt -->
- <!-- start class org.apache.hadoop.tools.rumen.MachineNode -->
- <class name="MachineNode" extends="org.apache.hadoop.tools.rumen.Node"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMemory" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the available physical RAM of the node.
- @return The available physical RAM of the node, in KB.]]>
- </doc>
- </method>
- <method name="getMapSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of map slots of the node.
- @return The number of map slots of the node.]]>
- </doc>
- </method>
- <method name="getReduceSlots" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of reduce slots of the node.
- @return The number of reduce slots fo the node.]]>
- </doc>
- </method>
- <method name="getMemoryPerMapSlot" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the amount of RAM reserved for each map slot.
- @return the amount of RAM reserved for each map slot, in KB.]]>
- </doc>
- </method>
- <method name="getMemoryPerReduceSlot" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the amount of RAM reserved for each reduce slot.
- @return the amount of RAM reserved for each reduce slot, in KB.]]>
- </doc>
- </method>
- <method name="getNumCores" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of cores of the node.
- @return the number of cores of the node.]]>
- </doc>
- </method>
- <method name="getRackNode" return="org.apache.hadoop.tools.rumen.RackNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the rack node that the machine belongs to.
-
- @return The rack node that the machine belongs to. Returns null if the
- machine does not belong to any rack.]]>
- </doc>
- </method>
- <method name="addChild" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="child" type="org.apache.hadoop.tools.rumen.Node"/>
- </method>
- <doc>
- <![CDATA[{@link MachineNode} represents the configuration of a cluster node.
- {@link MachineNode} should be constructed by {@link MachineNode.Builder}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.MachineNode -->
- <!-- start class org.apache.hadoop.tools.rumen.MachineNode.Builder -->
- <class name="MachineNode.Builder" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="MachineNode.Builder" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Start building a new NodeInfo object.
- @param name
- Unique name of the node. Typically the fully qualified domain
- name.]]>
- </doc>
- </constructor>
- <method name="setMemory" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="long"/>
- <doc>
- <![CDATA[Set the physical memory of the node.
- @param memory Available RAM in KB.]]>
- </doc>
- </method>
- <method name="setMapSlots" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="mapSlots" type="int"/>
- <doc>
- <![CDATA[Set the number of map slot for the node.
- @param mapSlots The number of map slots for the node.]]>
- </doc>
- </method>
- <method name="setReduceSlots" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reduceSlots" type="int"/>
- <doc>
- <![CDATA[Set the number of reduce slot for the node.
- @param reduceSlots The number of reduce slots for the node.]]>
- </doc>
- </method>
- <method name="setMemoryPerMapSlot" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memoryPerMapSlot" type="long"/>
- <doc>
- <![CDATA[Set the amount of RAM reserved for each map slot.
- @param memoryPerMapSlot The amount of RAM reserved for each map slot, in KB.]]>
- </doc>
- </method>
- <method name="setMemoryPerReduceSlot" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memoryPerReduceSlot" type="long"/>
- <doc>
- <![CDATA[Set the amount of RAM reserved for each reduce slot.
- @param memoryPerReduceSlot The amount of RAM reserved for each reduce slot, in KB.]]>
- </doc>
- </method>
- <method name="setNumCores" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numCores" type="int"/>
- <doc>
- <![CDATA[Set the number of cores for the node.
- @param numCores Number of cores for the node.]]>
- </doc>
- </method>
- <method name="cloneFrom" return="org.apache.hadoop.tools.rumen.MachineNode.Builder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ref" type="org.apache.hadoop.tools.rumen.MachineNode"/>
- <doc>
- <![CDATA[Clone the settings from a reference {@link MachineNode} object.
- @param ref The reference {@link MachineNode} object.]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.tools.rumen.MachineNode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Build the {@link MachineNode} object.
- @return The {@link MachineNode} object being built.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Builder for a NodeInfo object]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.MachineNode.Builder -->
- <!-- start class org.apache.hadoop.tools.rumen.MapAttempt20LineHistoryEventEmitter -->
- <class name="MapAttempt20LineHistoryEventEmitter" extends="org.apache.hadoop.tools.rumen.TaskAttempt20LineEventEmitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapAttempt20LineHistoryEventEmitter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.MapAttempt20LineHistoryEventEmitter -->
- <!-- start class org.apache.hadoop.tools.rumen.MapAttemptFinishedEvent -->
- <class name="MapAttemptFinishedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="MapAttemptFinishedEvent" type="org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.TaskType, java.lang.String, long, long, java.lang.String, java.lang.String, org.apache.hadoop.mapreduce.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event for successful completion of map attempts
- @param id Task Attempt ID
- @param taskType Type of the task
- @param taskStatus Status of the task
- @param mapFinishTime Finish time of the map phase
- @param finishTime Finish time of the attempt
- @param hostname Name of the host where the map executed
- @param state State string for the attempt
- @param counters Counters for the attempt]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task ID]]>
- </doc>
- </method>
- <method name="getAttemptId" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt id]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task status]]>
- </doc>
- </method>
- <method name="getMapFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the map phase finish time]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt finish time]]>
- </doc>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the host name]]>
- </doc>
- </method>
- <method name="getState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the state string]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.tools.rumen.JhCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the counters]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record successful completion of a map attempt]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.MapAttemptFinishedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.MapTaskAttemptInfo -->
- <class name="MapTaskAttemptInfo" extends="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MapTaskAttemptInfo" type="org.apache.hadoop.mapred.TaskStatus.State, org.apache.hadoop.tools.rumen.TaskInfo, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getMapRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the runtime for the <b>map</b> phase of the map-task attempt.
-
- @return the runtime for the <b>map</b> phase of the map-task attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link MapTaskAttemptInfo} represents the information with regard to a
- map task attempt.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.MapTaskAttemptInfo -->
- <!-- start class org.apache.hadoop.tools.rumen.Node -->
- <class name="Node" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Node" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@param name
- A unique name to identify a node in the cluster.
- @param level
- The level of the node in the cluster]]>
- </doc>
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the node.
-
- @return The name of the node.]]>
- </doc>
- </method>
- <method name="getLevel" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the level of the node.
- @return The level of the node.]]>
- </doc>
- </method>
- <method name="addChild" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="child" type="org.apache.hadoop.tools.rumen.Node"/>
- <doc>
- <![CDATA[Add a child node to this node.
- @param child The child node to be added. The child node should currently not be belong to another cluster topology.
- @return Boolean indicating whether the node is successfully added.]]>
- </doc>
- </method>
- <method name="hasChildren" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Does this node have any children?
- @return Boolean indicate whether this node has any children.]]>
- </doc>
- </method>
- <method name="getChildren" return="java.util.Set"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the children of this node.
-
- @return The children of this node. If no child, an empty set will be
- returned. The returned set is read-only.]]>
- </doc>
- </method>
- <method name="getParent" return="org.apache.hadoop.tools.rumen.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the parent node.
- @return the parent node. If root node, return null.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="org.apache.hadoop.tools.rumen.Node"/>
- </method>
- <doc>
- <![CDATA[{@link Node} represents a node in the cluster topology. A node can be a
- {@link MachineNode}, or a {@link RackNode}, etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Node -->
- <!-- start interface org.apache.hadoop.tools.rumen.Outputter -->
- <interface name="Outputter" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.io.Closeable"/>
- <method name="init"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="org.apache.hadoop.fs.Path"/>
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Initialize the {@link Outputter} to a specific path.
- @param path The {@link Path} to the output file.
- @param conf Configuration
- @throws IOException]]>
- </doc>
- </method>
- <method name="output"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="object" type="java.lang.Object"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Output an object.
- @param object The objecte.
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Interface to output a sequence of objects of type T.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.tools.rumen.Outputter -->
- <!-- start class org.apache.hadoop.tools.rumen.ParsedJob -->
- <class name="ParsedJob" extends="org.apache.hadoop.tools.rumen.LoggedJob"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="obtainTotalCounters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job total counters]]>
- </doc>
- </method>
- <method name="obtainMapCounters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job level map tasks' counters]]>
- </doc>
- </method>
- <method name="obtainReduceCounters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job level reduce tasks' counters]]>
- </doc>
- </method>
- <method name="obtainJobConfpath" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job conf path in staging dir on hdfs]]>
- </doc>
- </method>
- <method name="obtainJobAcls" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the job acls]]>
- </doc>
- </method>
- <method name="obtainMapTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the list of map tasks of this job]]>
- </doc>
- </method>
- <method name="obtainReduceTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the list of reduce tasks of this job]]>
- </doc>
- </method>
- <method name="obtainOtherTasks" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the list of other tasks of this job]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is a wrapper class around {@link LoggedJob}. This provides also the
- extra information about the job obtained from job history which is not
- written to the JSON trace file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ParsedJob -->
- <!-- start class org.apache.hadoop.tools.rumen.ParsedTask -->
- <class name="ParsedTask" extends="org.apache.hadoop.tools.rumen.LoggedTask"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="incorporateCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.tools.rumen.JhCounters"/>
- </method>
- <method name="putCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the task counters]]>
- </doc>
- </method>
- <method name="obtainCounters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the task counters]]>
- </doc>
- </method>
- <method name="putDiagnosticInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="msg" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the task diagnostic-info]]>
- </doc>
- </method>
- <method name="obtainDiagnosticInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the diagnostic-info of this task.
- If the task is successful, returns null.]]>
- </doc>
- </method>
- <method name="putFailedDueToAttemptId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attempt" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the failed-due-to-attemptId info of this task.]]>
- </doc>
- </method>
- <method name="obtainFailedDueToAttemptId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the failed-due-to-attemptId info of this task.
- If the task is successful, returns null.]]>
- </doc>
- </method>
- <method name="obtainTaskAttempts" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This is a wrapper class around {@link LoggedTask}. This provides also the
- extra information about the task obtained from job history which is not
- written to the JSON trace file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ParsedTask -->
- <!-- start class org.apache.hadoop.tools.rumen.ParsedTaskAttempt -->
- <class name="ParsedTaskAttempt" extends="org.apache.hadoop.tools.rumen.LoggedTaskAttempt"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="incorporateCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="org.apache.hadoop.tools.rumen.JhCounters"/>
- <doc>
- <![CDATA[incorporate event counters]]>
- </doc>
- </method>
- <method name="putCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="counters" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the task attempt counters]]>
- </doc>
- </method>
- <method name="obtainCounters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the task attempt counters]]>
- </doc>
- </method>
- <method name="putDiagnosticInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="msg" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the task attempt diagnostic-info]]>
- </doc>
- </method>
- <method name="obtainDiagnosticInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the diagnostic-info of this task attempt.
- If the attempt is successful, returns null.]]>
- </doc>
- </method>
- <method name="obtainTrackerName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the tracker name where the attempt was run.]]>
- </doc>
- </method>
- <method name="obtainHttpPort" return="java.lang.Integer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return http port if set. Returns null otherwise.]]>
- </doc>
- </method>
- <method name="obtainStateString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return state string of the task attempt.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This is a wrapper class around {@link LoggedTaskAttempt}. This provides
- also the extra information about the task attempt obtained from
- job history which is not written to the JSON trace file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ParsedTaskAttempt -->
- <!-- start class org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants -->
- <class name="Pre21JobHistoryConstants" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Pre21JobHistoryConstants"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants -->
- <!-- start class org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values -->
- <class name="Pre21JobHistoryConstants.Values" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <field name="SUCCESS" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FAILED" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="KILLED" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAP" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REDUCE" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLEANUP" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RUNNING" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PREP" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SETUP" type="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This enum contains some of the values commonly used by history log events.
- since values in history can only be strings - Values.name() is used in
- most places in history file.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values -->
- <!-- start class org.apache.hadoop.tools.rumen.RackNode -->
- <class name="RackNode" extends="org.apache.hadoop.tools.rumen.Node"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <constructor name="RackNode" type="java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="addChild" return="boolean"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="child" type="org.apache.hadoop.tools.rumen.Node"/>
- </method>
- <method name="getMachinesInRack" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the machine nodes that belong to the rack.
- @return The machine nodes that belong to the rack.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link RackNode} represents a rack node in the cluster topology.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.RackNode -->
- <!-- start class org.apache.hadoop.tools.rumen.RandomSeedGenerator -->
- <class name="RandomSeedGenerator" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RandomSeedGenerator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSeed" return="long"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="streamId" type="java.lang.String"/>
- <param name="masterSeed" type="long"/>
- <doc>
- <![CDATA[Generates a new random seed.
- @param streamId a string identifying the stream of random numbers
- @param masterSeed higher level master random seed
- @return the random seed. Different (streamId, masterSeed) pairs result in
- (vastly) different random seeds.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The purpose of this class is to generate new random seeds from a master
- seed. This is needed to make the Random().next*() calls in rumen and mumak
- deterministic so that mumak simulations become deterministically replayable.
- In these tools we need many independent streams of random numbers, some of
- which are created dynamically. We seed these streams with the sub-seeds
- returned by RandomSeedGenerator.
-
- For a slightly more complicated approach to generating multiple streams of
- random numbers with better theoretical guarantees, see
- P. L'Ecuyer, R. Simard, E. J. Chen, and W. D. Kelton,
- ``An Objected-Oriented Random-Number Package with Many Long Streams and
- Substreams'', Operations Research, 50, 6 (2002), 1073--1075
- http://www.iro.umontreal.ca/~lecuyer/papers.html
- http://www.iro.umontreal.ca/~lecuyer/myftp/streams00/]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.RandomSeedGenerator -->
- <!-- start class org.apache.hadoop.tools.rumen.ReduceAttempt20LineHistoryEventEmitter -->
- <class name="ReduceAttempt20LineHistoryEventEmitter" extends="org.apache.hadoop.tools.rumen.TaskAttempt20LineEventEmitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ReduceAttempt20LineHistoryEventEmitter -->
- <!-- start class org.apache.hadoop.tools.rumen.ReduceAttemptFinishedEvent -->
- <class name="ReduceAttemptFinishedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="ReduceAttemptFinishedEvent" type="org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.TaskType, java.lang.String, long, long, long, java.lang.String, java.lang.String, org.apache.hadoop.mapreduce.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record completion of a reduce attempt
- @param id Attempt Id
- @param taskType Type of task
- @param taskStatus Status of the task
- @param shuffleFinishTime Finish time of the shuffle phase
- @param sortFinishTime Finish time of the sort phase
- @param finishTime Finish time of the attempt
- @param hostname Name of the host where the attempt executed
- @param state State of the attempt
- @param counters Counters for the attempt]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Task ID]]>
- </doc>
- </method>
- <method name="getAttemptId" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt id]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task status]]>
- </doc>
- </method>
- <method name="getSortFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the finish time of the sort phase]]>
- </doc>
- </method>
- <method name="getShuffleFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the finish time of the shuffle phase]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the finish time of the attempt]]>
- </doc>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the host where the attempt ran]]>
- </doc>
- </method>
- <method name="getState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the state string]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.tools.rumen.JhCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the counters for the attempt]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record successful completion of a reduce attempt]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ReduceAttemptFinishedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.ReduceTaskAttemptInfo -->
- <class name="ReduceTaskAttemptInfo" extends="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReduceTaskAttemptInfo" type="org.apache.hadoop.mapred.TaskStatus.State, org.apache.hadoop.tools.rumen.TaskInfo, long, long, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getReduceRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the runtime for the <b>reduce</b> phase of the reduce task-attempt.
-
- @return the runtime for the <b>reduce</b> phase of the reduce task-attempt]]>
- </doc>
- </method>
- <method name="getShuffleRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the runtime for the <b>shuffle</b> phase of the reduce task-attempt.
-
- @return the runtime for the <b>shuffle</b> phase of the reduce task-attempt]]>
- </doc>
- </method>
- <method name="getMergeRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the runtime for the <b>merge</b> phase of the reduce task-attempt
-
- @return the runtime for the <b>merge</b> phase of the reduce task-attempt]]>
- </doc>
- </method>
- <method name="getRuntime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[{@link ReduceTaskAttemptInfo} represents the information with regard to a
- reduce task attempt.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ReduceTaskAttemptInfo -->
- <!-- start class org.apache.hadoop.tools.rumen.ResourceUsageMetrics -->
- <class name="ResourceUsageMetrics" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.io.Writable"/>
- <implements name="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <constructor name="ResourceUsageMetrics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getCumulativeCpuUsage" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the cumulative CPU usage.]]>
- </doc>
- </method>
- <method name="setCumulativeCpuUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="usage" type="long"/>
- <doc>
- <![CDATA[Set the cumulative CPU usage.]]>
- </doc>
- </method>
- <method name="getVirtualMemoryUsage" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the virtual memory usage.]]>
- </doc>
- </method>
- <method name="setVirtualMemoryUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="usage" type="long"/>
- <doc>
- <![CDATA[Set the virtual memory usage.]]>
- </doc>
- </method>
- <method name="getPhysicalMemoryUsage" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the physical memory usage.]]>
- </doc>
- </method>
- <method name="setPhysicalMemoryUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="usage" type="long"/>
- <doc>
- <![CDATA[Set the physical memory usage.]]>
- </doc>
- </method>
- <method name="getHeapUsage" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total heap usage.]]>
- </doc>
- </method>
- <method name="setHeapUsage"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="usage" type="long"/>
- <doc>
- <![CDATA[Set the total heap usage.]]>
- </doc>
- </method>
- <method name="size" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Returns the size of the serialized data]]>
- </doc>
- </method>
- <method name="readFields"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="in" type="java.io.DataInput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="write"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="out" type="java.io.DataOutput"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="deepCompare"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.tools.rumen.DeepCompare"/>
- <param name="loc" type="org.apache.hadoop.tools.rumen.TreePath"/>
- <exception name="DeepInequalityException" type="org.apache.hadoop.tools.rumen.DeepInequalityException"/>
- </method>
- <doc>
- <![CDATA[Captures the resource usage metrics.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ResourceUsageMetrics -->
- <!-- start class org.apache.hadoop.tools.rumen.RewindableInputStream -->
- <class name="RewindableInputStream" extends="java.io.InputStream"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RewindableInputStream" type="java.io.InputStream"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor.
-
- @param input]]>
- </doc>
- </constructor>
- <constructor name="RewindableInputStream" type="java.io.InputStream, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Constructor
-
- @param input
- input stream.
- @param maxBytesToRemember
- Maximum number of bytes we need to remember at the beginning of
- the stream. If {@link #rewind()} is called after so many bytes are
- read from the stream, {@link #rewind()} would fail.]]>
- </doc>
- </constructor>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="read" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="buffer" type="byte[]"/>
- <param name="offset" type="int"/>
- <param name="length" type="int"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="rewind" return="java.io.InputStream"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[A simple wrapper class to make any input stream "rewindable". It could be
- made more memory efficient by grow the internal buffer adaptively.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.RewindableInputStream -->
- <!-- start class org.apache.hadoop.tools.rumen.Task20LineHistoryEventEmitter -->
- <class name="Task20LineHistoryEventEmitter" extends="org.apache.hadoop.tools.rumen.HistoryEventEmitter"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Task20LineHistoryEventEmitter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.Task20LineHistoryEventEmitter -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskAttempt20LineEventEmitter -->
- <class name="TaskAttempt20LineEventEmitter" extends="org.apache.hadoop.tools.rumen.HistoryEventEmitter"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskAttempt20LineEventEmitter"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskAttempt20LineEventEmitter -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskAttemptFinishedEvent -->
- <class name="TaskAttemptFinishedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskAttemptFinishedEvent" type="org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.TaskType, java.lang.String, long, java.lang.String, java.lang.String, org.apache.hadoop.mapreduce.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record successful finishes for setup and cleanup
- attempts
- @param id Attempt ID
- @param taskType Type of task
- @param taskStatus Status of task
- @param finishTime Finish time of attempt
- @param hostname Host where the attempt executed
- @param state State string
- @param counters Counters for the attempt]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task ID]]>
- </doc>
- </method>
- <method name="getAttemptId" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task attempt id]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task status]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt finish time]]>
- </doc>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the host where the attempt executed]]>
- </doc>
- </method>
- <method name="getState" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the state string]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.tools.rumen.JhCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the counters for the attempt]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record successful task completion]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskAttemptFinishedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskAttemptInfo -->
- <class name="TaskAttemptInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskAttemptInfo" type="org.apache.hadoop.mapred.TaskStatus.State, org.apache.hadoop.tools.rumen.TaskInfo"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getRunState" return="org.apache.hadoop.mapred.TaskStatus.State"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the final {@link State} of the task-attempt.
-
- @return the final <code>State</code> of the task-attempt]]>
- </doc>
- </method>
- <method name="getRuntime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the total runtime for the task-attempt.
-
- @return the total runtime for the task-attempt]]>
- </doc>
- </method>
- <method name="getTaskInfo" return="org.apache.hadoop.tools.rumen.TaskInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link TaskInfo} for the given task-attempt.
-
- @return the <code>TaskInfo</code> for the given task-attempt]]>
- </doc>
- </method>
- <field name="state" type="org.apache.hadoop.mapred.TaskStatus.State"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="taskInfo" type="org.apache.hadoop.tools.rumen.TaskInfo"
- transient="false" volatile="false"
- static="false" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[{@link TaskAttemptInfo} is a collection of statistics about a particular
- task-attempt gleaned from job-history of the job.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskAttemptInfo -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskAttemptStartedEvent -->
- <class name="TaskAttemptStartedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskAttemptStartedEvent" type="org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.TaskType, long, java.lang.String, int, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record the start of an attempt
- @param attemptId Id of the attempt
- @param taskType Type of task
- @param startTime Start time of the attempt
- @param trackerName Name of the Task Tracker where attempt is running
- @param httpPort The port number of the tracker
- @param locality the locality of the task attempt
- @param avataar the avataar of the task attempt]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task id]]>
- </doc>
- </method>
- <method name="getTrackerName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the tracker name]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start time]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getHttpPort" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the HTTP port]]>
- </doc>
- </method>
- <method name="getTaskAttemptId" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt id]]>
- </doc>
- </method>
- <method name="getLocality" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the locality of the task attempt]]>
- </doc>
- </method>
- <method name="getAvataar" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the avataar of the task attempt]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record start of a task attempt]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskAttemptStartedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskAttemptUnsuccessfulCompletionEvent -->
- <class name="TaskAttemptUnsuccessfulCompletionEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskAttemptUnsuccessfulCompletionEvent" type="org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.TaskType, java.lang.String, long, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record the unsuccessful completion of attempts
- @param id Attempt ID
- @param taskType Type of the task
- @param status Status of the attempt
- @param finishTime Finish time of the attempt
- @param hostname Name of the host where the attempt executed
- @param error Error string]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task id]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getTaskAttemptId" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt id]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the finish time]]>
- </doc>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the host where the attempt executed]]>
- </doc>
- </method>
- <method name="getError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the error string]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record unsuccessful (Killed/Failed) completion of task attempts]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskAttemptUnsuccessfulCompletionEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskFailedEvent -->
- <class name="TaskFailedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskFailedEvent" type="org.apache.hadoop.mapreduce.TaskID, long, org.apache.hadoop.mapreduce.TaskType, java.lang.String, java.lang.String, org.apache.hadoop.mapreduce.TaskAttemptID"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record task failure
- @param id Task ID
- @param finishTime Finish time of the task
- @param taskType Type of the task
- @param error Error String
- @param status Status
- @param failedDueToAttempt The attempt id due to which the task failed]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task id]]>
- </doc>
- </method>
- <method name="getError" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the error string]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the finish time of the attempt]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getFailedAttemptID" return="org.apache.hadoop.mapreduce.TaskAttemptID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attempt id due to which the task failed]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the failure of a task]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskFailedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskFinishedEvent -->
- <class name="TaskFinishedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskFinishedEvent" type="org.apache.hadoop.mapreduce.TaskID, long, org.apache.hadoop.mapreduce.TaskType, java.lang.String, org.apache.hadoop.mapreduce.Counters"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record the successful completion of a task
- @param id Task ID
- @param finishTime Finish time of the task
- @param taskType Type of the task
- @param status Status string
- @param counters Counters for the task]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task id]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task finish time]]>
- </doc>
- </method>
- <method name="getCounters" return="org.apache.hadoop.tools.rumen.JhCounters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task counters]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task type]]>
- </doc>
- </method>
- <method name="getTaskStatus" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get task status]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the successful completion of a task]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskFinishedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskInfo -->
- <class name="TaskInfo" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TaskInfo" type="long, int, long, int, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TaskInfo" type="long, int, long, int, long, org.apache.hadoop.tools.rumen.ResourceUsageMetrics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getInputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Raw bytes read from the FileSystem into the task. Note that this
- may not always match the input bytes to the task.]]>
- </doc>
- </method>
- <method name="getInputRecords" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Number of records input to this task.]]>
- </doc>
- </method>
- <method name="getOutputBytes" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Raw bytes written to the destination FileSystem. Note that this may
- not match output bytes.]]>
- </doc>
- </method>
- <method name="getOutputRecords" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Number of records output from this task.]]>
- </doc>
- </method>
- <method name="getTaskMemory" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Memory used by the task leq the heap size.]]>
- </doc>
- </method>
- <method name="getResourceUsageMetrics" return="org.apache.hadoop.tools.rumen.ResourceUsageMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Resource usage metrics]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskInfo -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskStartedEvent -->
- <class name="TaskStartedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskStartedEvent" type="org.apache.hadoop.mapreduce.TaskID, long, org.apache.hadoop.mapreduce.TaskType, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record start of a task
- @param id Task Id
- @param startTime Start time of the task
- @param taskType Type of the task
- @param splitLocations Split locations, applicable for map tasks]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task id]]>
- </doc>
- </method>
- <method name="getSplitLocations" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the split locations, applicable for map tasks]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start time of the task]]>
- </doc>
- </method>
- <method name="getTaskType" return="org.apache.hadoop.mapreduce.TaskType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task type]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record the start of a task]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskStartedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TaskUpdatedEvent -->
- <class name="TaskUpdatedEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <constructor name="TaskUpdatedEvent" type="org.apache.hadoop.mapreduce.TaskID, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create an event to record task updates
- @param id Id of the task
- @param finishTime Finish time of the task]]>
- </doc>
- </constructor>
- <method name="getTaskId" return="org.apache.hadoop.mapreduce.TaskID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task ID]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the task finish time]]>
- </doc>
- </method>
- <method name="getEventType" return="org.apache.hadoop.tools.rumen.EventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Event to record updates to a task]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TaskUpdatedEvent -->
- <!-- start class org.apache.hadoop.tools.rumen.TopologyBuilder -->
- <class name="TopologyBuilder" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TopologyBuilder"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.tools.rumen.HistoryEvent"/>
- <doc>
- <![CDATA[Process one {@link HistoryEvent}
-
- @param event
- The {@link HistoryEvent} to be processed.]]>
- </doc>
- </method>
- <method name="process"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="java.util.Properties"/>
- <doc>
- <![CDATA[Process a collection of JobConf {@link Properties}. We do not restrict it
- to be called once.
-
- @param conf
- The job conf properties to be added.]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.tools.rumen.LoggedNetworkTopology"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Request the builder to build the final object. Once called, the
- {@link TopologyBuilder} would accept no more events or job-conf properties.
-
- @return Parsed {@link LoggedNetworkTopology} object.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Building the cluster topology.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TopologyBuilder -->
- <!-- start class org.apache.hadoop.tools.rumen.TraceBuilder -->
- <class name="TraceBuilder" extends="org.apache.hadoop.conf.Configured"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.util.Tool"/>
- <constructor name="TraceBuilder"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- </method>
- <method name="run" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <doc>
- <![CDATA[The main driver of the Rumen Parser.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TraceBuilder -->
- <!-- start class org.apache.hadoop.tools.rumen.TreePath -->
- <class name="TreePath" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TreePath" type="org.apache.hadoop.tools.rumen.TreePath, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TreePath" type="org.apache.hadoop.tools.rumen.TreePath, java.lang.String, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[This describes a path from a node to the root. We use it when we compare two
- trees during rumen unit tests. If the trees are not identical, this chain
- will be converted to a string which describes the path from the root to the
- fields that did not compare.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.TreePath -->
- <!-- start class org.apache.hadoop.tools.rumen.ZombieCluster -->
- <class name="ZombieCluster" extends="org.apache.hadoop.tools.rumen.AbstractClusterStory"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ZombieCluster" type="org.apache.hadoop.tools.rumen.LoggedNetworkTopology, org.apache.hadoop.tools.rumen.MachineNode"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Construct a homogeneous cluster. We assume that the leaves on the topology
- are {@link MachineNode}s, and the parents of {@link MachineNode}s are
- {@link RackNode}s. We also expect all leaf nodes are on the same level.
-
- @param topology
- The network topology.
- @param defaultNode
- The default node setting.]]>
- </doc>
- </constructor>
- <constructor name="ZombieCluster" type="org.apache.hadoop.fs.Path, org.apache.hadoop.tools.rumen.MachineNode, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a homogeneous cluster. We assume that the leaves on the topology
- are {@link MachineNode}s, and the parents of {@link MachineNode}s are
- {@link RackNode}s. We also expect all leaf nodes are on the same level.
-
- @param path Path to the JSON-encoded topology file.
- @param conf
- @param defaultNode
- The default node setting.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ZombieCluster" type="java.io.InputStream, org.apache.hadoop.tools.rumen.MachineNode"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Construct a homogeneous cluster. We assume that the leaves on the topology
- are {@link MachineNode}s, and the parents of {@link MachineNode}s are
- {@link RackNode}s. We also expect all leaf nodes are on the same level.
-
- @param input The input stream for the JSON-encoded topology file.
- @param defaultNode
- The default node setting.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="getClusterTopology" return="org.apache.hadoop.tools.rumen.Node"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[{@link ZombieCluster} rebuilds the cluster topology using the information
- obtained from job history logs.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ZombieCluster -->
- <!-- start class org.apache.hadoop.tools.rumen.ZombieJob -->
- <class name="ZombieJob" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.JobStory"/>
- <constructor name="ZombieJob" type="org.apache.hadoop.tools.rumen.LoggedJob, org.apache.hadoop.tools.rumen.ClusterStory, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor creates a {@link ZombieJob} with the same semantics as the
- {@link LoggedJob} passed in this parameter
-
- @param job
- The dead job this ZombieJob instance is based on.
- @param cluster
- The cluster topology where the dead job ran on. This argument can
- be null if we do not have knowledge of the cluster topology.
- @param seed
- Seed for the random number generator for filling in information
- not available from the ZombieJob.]]>
- </doc>
- </constructor>
- <constructor name="ZombieJob" type="org.apache.hadoop.tools.rumen.LoggedJob, org.apache.hadoop.tools.rumen.ClusterStory"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constructor creates a {@link ZombieJob} with the same semantics as the
- {@link LoggedJob} passed in this parameter
-
- @param job
- The dead job this ZombieJob instance is based on.
- @param cluster
- The cluster topology where the dead job ran on. This argument can
- be null if we do not have knowledge of the cluster topology.]]>
- </doc>
- </constructor>
- <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
- abstract="false" native="false" synchronized="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getInputSplits" return="org.apache.hadoop.mapreduce.InputSplit[]"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumberMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumberReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getOutcome" return="org.apache.hadoop.tools.rumen.Pre21JobHistoryConstants.Values"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getSubmissionTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumLoggedMaps" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getting the number of map tasks that are actually logged in the trace.
- @return The number of map tasks that are actually logged in the trace.]]>
- </doc>
- </method>
- <method name="getNumLoggedReduces" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Getting the number of reduce tasks that are actually logged in the trace.
- @return The number of map tasks that are actually logged in the trace.]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLoggedJob" return="org.apache.hadoop.tools.rumen.LoggedJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the underlining {@link LoggedJob} object read directly from the trace.
- This is mainly for debugging.
-
- @return the underlining {@link LoggedJob} object]]>
- </doc>
- </method>
- <method name="getTaskAttemptInfo" return="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="taskNumber" type="int"/>
- <param name="taskAttemptNumber" type="int"/>
- <doc>
- <![CDATA[Get a {@link TaskAttemptInfo} with a {@link TaskAttemptID} associated with
- taskType, taskNumber, and taskAttemptNumber. This function does not care
- about locality, and follows the following decision logic: 1. Make up a
- {@link TaskAttemptInfo} if the task attempt is missing in trace, 2. Make up
- a {@link TaskAttemptInfo} if the task attempt has a KILLED final status in
- trace, 3. Otherwise (final state is SUCCEEDED or FAILED), construct the
- {@link TaskAttemptInfo} from the trace.]]>
- </doc>
- </method>
- <method name="getTaskInfo" return="org.apache.hadoop.tools.rumen.TaskInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskType" type="org.apache.hadoop.mapreduce.TaskType"/>
- <param name="taskNumber" type="int"/>
- </method>
- <method name="getMapTaskAttemptInfoAdjusted" return="org.apache.hadoop.tools.rumen.TaskAttemptInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="taskNumber" type="int"/>
- <param name="taskAttemptNumber" type="int"/>
- <param name="locality" type="int"/>
- <doc>
- <![CDATA[Get a {@link TaskAttemptInfo} with a {@link TaskAttemptID} associated with
- taskType, taskNumber, and taskAttemptNumber. This function considers
- locality, and follows the following decision logic: 1. Make up a
- {@link TaskAttemptInfo} if the task attempt is missing in trace, 2. Make up
- a {@link TaskAttemptInfo} if the task attempt has a KILLED final status in
- trace, 3. If final state is FAILED, construct a {@link TaskAttemptInfo}
- from the trace, without considering locality. 4. If final state is
- SUCCEEDED, construct a {@link TaskAttemptInfo} from the trace, with runtime
- scaled according to locality in simulation and locality in trace.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ZombieJob} is a layer above {@link LoggedJob} raw JSON objects.
-
- Each {@link ZombieJob} object represents a job in job history. For everything
- that exists in job history, contents are returned unchanged faithfully. To
- get input splits of a non-exist task, a non-exist task attempt, or an
- ill-formed task attempt, proper objects are made up from statistical
- sketches.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ZombieJob -->
- <!-- start class org.apache.hadoop.tools.rumen.ZombieJobProducer -->
- <class name="ZombieJobProducer" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.tools.rumen.JobStoryProducer"/>
- <constructor name="ZombieJobProducer" type="org.apache.hadoop.fs.Path, org.apache.hadoop.tools.rumen.ZombieCluster, org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param path
- Path to the JSON trace file, possibly compressed.
- @param cluster
- The topology of the cluster that corresponds to the jobs in the
- trace. The argument can be null if we do not have knowledge of the
- cluster topology.
- @param conf
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ZombieJobProducer" type="org.apache.hadoop.fs.Path, org.apache.hadoop.tools.rumen.ZombieCluster, org.apache.hadoop.conf.Configuration, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param path
- Path to the JSON trace file, possibly compressed.
- @param cluster
- The topology of the cluster that corresponds to the jobs in the
- trace. The argument can be null if we do not have knowledge of the
- cluster topology.
- @param conf
- @param randomSeed
- use a deterministic seed.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ZombieJobProducer" type="java.io.InputStream, org.apache.hadoop.tools.rumen.ZombieCluster"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param input
- The input stream for the JSON trace.
- @param cluster
- The topology of the cluster that corresponds to the jobs in the
- trace. The argument can be null if we do not have knowledge of the
- cluster topology.
- @throws IOException]]>
- </doc>
- </constructor>
- <constructor name="ZombieJobProducer" type="java.io.InputStream, org.apache.hadoop.tools.rumen.ZombieCluster, long"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Constructor
-
- @param input
- The input stream for the JSON trace.
- @param cluster
- The topology of the cluster that corresponds to the jobs in the
- trace. The argument can be null if we do not have knowledge of the
- cluster topology.
- @param randomSeed
- use a deterministic seed.
- @throws IOException]]>
- </doc>
- </constructor>
- <method name="getNextJob" return="org.apache.hadoop.tools.rumen.ZombieJob"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="close"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <doc>
- <![CDATA[Producing {@link JobStory}s from job trace.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.tools.rumen.ZombieJobProducer -->
- </package>
- </api>
|
